Skip to content

Commit fb6d144

Browse files
README: Restructure + spell corrections of help page
1 parent 2758c60 commit fb6d144

File tree

5 files changed

+51
-45
lines changed

5 files changed

+51
-45
lines changed

OVERVIEW.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -105,27 +105,6 @@ handlers("txtprogressbar", "beepr")
105105

106106
## Support for progressr elsewhere
107107

108-
### The plyr package
109-
110-
The functions in the [**plyr**](https://cran.r-project.org/package=plyr) package take argument `.progress`, which can be used to produce progress updates. To have them generate **progressr** 'progression' updates, use `.progress = "progressr"`. For example,
111-
```r
112-
library(plyr)
113-
library(progressr)
114-
115-
xs <- 1:5
116-
117-
with_progress({
118-
y <- l_ply(xs, function(x, ...) {
119-
Sys.sleep(6.0-x)
120-
sqrt(x)
121-
}, .progress = "progressr")
122-
})
123-
## |===================== | 40%
124-
```
125-
126-
_Comment_: This also works when using `.parallel = TRUE` with a **[foreach]** parallel-backend such as **[doParallel]** or **[doFuture]** registered.
127-
128-
129108
### The future framework
130109

131110
The **[future]** framework has built-in support for the kind of progression updates produced by the **progressr** package. This means that you can use it with for instance **[future.apply]**, **[furrr]]*, and **[foreach]**+**[doFuture]**.
@@ -182,6 +161,27 @@ with_progress({
182161
```
183162

184163

164+
### The plyr package
165+
166+
The functions in the [**plyr**](https://cran.r-project.org/package=plyr) package take argument `.progress`, which can be used to produce progress updates. To have them generate **progressr** 'progression' updates, use `.progress = "progressr"`. For example,
167+
```r
168+
library(plyr)
169+
library(progressr)
170+
171+
xs <- 1:5
172+
173+
with_progress({
174+
y <- l_ply(xs, function(x, ...) {
175+
Sys.sleep(6.0-x)
176+
sqrt(x)
177+
}, .progress = "progressr")
178+
})
179+
## |===================== | 40%
180+
```
181+
182+
_Comment_: This also works when using `.parallel = TRUE` with a **[foreach]** parallel-backend such as **[doParallel]** or **[doFuture]** registered.
183+
184+
185185

186186

187187

R/withProgress2.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Plug-in backward compatibily replacement for shiny::withProgress()
1+
#' Plug-in backward compatibility replacement for shiny::withProgress()
22
#'
33
#' @param expr,\ldots,env,quoted Arguments passed to [shiny::withProgress] as is.
44
#'

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -107,27 +107,6 @@ handlers("txtprogressbar", "beepr")
107107

108108
## Support for progressr elsewhere
109109

110-
### The plyr package
111-
112-
The functions in the [**plyr**](https://cran.r-project.org/package=plyr) package take argument `.progress`, which can be used to produce progress updates. To have them generate **progressr** 'progression' updates, use `.progress = "progressr"`. For example,
113-
```r
114-
library(plyr)
115-
library(progressr)
116-
117-
xs <- 1:5
118-
119-
with_progress({
120-
y <- l_ply(xs, function(x, ...) {
121-
Sys.sleep(6.0-x)
122-
sqrt(x)
123-
}, .progress = "progressr")
124-
})
125-
## |===================== | 40%
126-
```
127-
128-
_Comment_: This also works when using `.parallel = TRUE` with a **[foreach]** parallel-backend such as **[doParallel]** or **[doFuture]** registered.
129-
130-
131110
### The future framework
132111

133112
The **[future]** framework has built-in support for the kind of progression updates produced by the **progressr** package. This means that you can use it with for instance **[future.apply]**, **[furrr]]*, and **[foreach]**+**[doFuture]**.
@@ -184,6 +163,27 @@ with_progress({
184163
```
185164

186165

166+
### The plyr package
167+
168+
The functions in the [**plyr**](https://cran.r-project.org/package=plyr) package take argument `.progress`, which can be used to produce progress updates. To have them generate **progressr** 'progression' updates, use `.progress = "progressr"`. For example,
169+
```r
170+
library(plyr)
171+
library(progressr)
172+
173+
xs <- 1:5
174+
175+
with_progress({
176+
y <- l_ply(xs, function(x, ...) {
177+
Sys.sleep(6.0-x)
178+
sqrt(x)
179+
}, .progress = "progressr")
180+
})
181+
## |===================== | 40%
182+
```
183+
184+
_Comment_: This also works when using `.parallel = TRUE` with a **[foreach]** parallel-backend such as **[doParallel]** or **[doFuture]** registered.
185+
186+
187187

188188

189189

inst/WORDLIST

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@ AppVeyor
22
beepr
33
BEL
44
CMD
5+
doFuture
6+
doParallel
7+
foreach
8+
furrr
59
github
610
HenrikBengtsson
711
https
12+
lapply
813
macOS
914
NL
1015
parallelize
@@ -19,3 +24,4 @@ roadmap
1924
Roadmap
2025
Rprofile
2126
substyle
27+
withProgress

man/withProgress2.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)