Skip to content

Commit 4268a76

Browse files
Add lifecycle badge
1 parent 28fc802 commit 4268a76

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

OVERVIEW.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)
2+
13
The **[progressr]** package provides a minimal API for reporting progress updates in [R](https://www.r-project.org/). The design is to separate the representation of progress updates from how they are presented. What type of progress to signal is controlled by the developer. How these progress updates are rendered is controlled by the end user. For instance, some users may prefer visual feedback such as a horizontal progress bar in the terminal, whereas others may prefer auditory feedback.
24

35
Design motto:
@@ -112,11 +114,11 @@ with_progress({
112114

113115
### The future framework
114116

115-
The **[future]** framework has built-in support for the kind of progression updates produced by the **progressr** package.
117+
The **[future]** framework has built-in support for the kind of progression updates produced by the **progressr** package. Here is an example that uses `future_lapply() of the **[future.apply]** package to parallelize on the local machine while at the same time signaling progression updates:
116118

117119
```r
118120
library(future.apply)
119-
plan(multisession, workers = 2)
121+
plan(multisession)
120122

121123
library(progressr)
122124
handlers("progress", "beepr")
@@ -194,3 +196,4 @@ To debug progress updates, use:
194196
[beepr]: https://cran.r-project.org/package=beepr
195197
[progress]: https://cran.r-project.org/package=progress
196198
[future]: https://cran.r-project.org/package=future
199+
[future.apply]: https://cran.r-project.org/package=future.apply

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# progressr: A Unifying API for Progress Updates
22

3+
![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)
4+
35
The **[progressr]** package provides a minimal API for reporting progress updates in [R](https://www.r-project.org/). The design is to separate the representation of progress updates from how they are presented. What type of progress to signal is controlled by the developer. How these progress updates are rendered is controlled by the end user. For instance, some users may prefer visual feedback such as a horizontal progress bar in the terminal, whereas others may prefer auditory feedback.
46

57
Design motto:
@@ -114,11 +116,11 @@ with_progress({
114116

115117
### The future framework
116118

117-
The **[future]** framework has built-in support for the kind of progression updates produced by the **progressr** package.
119+
The **[future]** framework has built-in support for the kind of progression updates produced by the **progressr** package. Here is an example that uses `future_lapply() of the **[future.apply]** package to parallelize on the local machine while at the same time signaling progression updates:
118120

119121
```r
120122
library(future.apply)
121-
plan(multisession, workers = 2)
123+
plan(multisession)
122124

123125
library(progressr)
124126
handlers("progress", "beepr")
@@ -196,6 +198,7 @@ To debug progress updates, use:
196198
[beepr]: https://cran.r-project.org/package=beepr
197199
[progress]: https://cran.r-project.org/package=progress
198200
[future]: https://cran.r-project.org/package=future
201+
[future.apply]: https://cran.r-project.org/package=future.apply
199202

200203
## Installation
201204
R package progressr is only available via [GitHub](https://github.com/HenrikBengtsson/progressr) and can be installed in R as:

0 commit comments

Comments
 (0)