CITATION.cff

# ------------------------------------------------
# CITATION.cff file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# ------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "progressr" in publications use:'
type: software
license: Apache-2.0
title: 'progressr: An Inclusive, Unifying API for Progress Updates'
doi: 10.32614/CRAN.package.progressr
abstract: A minimal, unifying API for scripts and packages to report progress updates
  from anywhere including when using parallel processing. The package is designed
  such that the developer can to focus on what progress should be reported on without
  having to worry about how to present it. The end user has full control of how, where,
  and when to render these progress updates, e.g. in the terminal using utils::txtProgressBar(),
  cli::cli_progress_bar(), in a graphical user interface using utils::winProgressBar(),
  tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beepr::beep(),
  or on a file system via the size of a file. Anyone can add additional, customized,
  progression handlers. The 'progressr' package uses R's condition framework for signaling
  progress updated. Because of this, progress can be reported from almost anywhere
  in R, e.g. from classical for and while loops, from map-reduce API:s like the lapply()
  family of functions, 'purrr', 'plyr', and 'foreach'. It will also work with parallel
  processing via the 'future' framework, e.g. 'lapply(...) |> futurize()' and 'purrr::map(...)
  |> futurize()', which uses future.apply::future_lapply() and furrr::future_map()
  internally. The package is compatible with Shiny applications.
authors:
- family-names: Bengtsson
  given-names: Henrik
  email: henrikb@braju.com
  orcid: https://orcid.org/0000-0002-7579-5165
repository: https://CRAN.R-project.org/package=progressr
repository-code: https://github.com/futureverse/progressr
url: https://progressr.futureverse.org
contact:
- family-names: Bengtsson
  given-names: Henrik
  email: henrikb@braju.com
  orcid: https://orcid.org/0000-0002-7579-5165