Skip to content

Commit 5b1aaf9

Browse files
Update vignette & README
1 parent 72ce8c0 commit 5b1aaf9

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

OVERVIEW.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,16 @@ handlers("txtprogressbar", "beepr")
103103
```
104104

105105

106+
### Silence all progress
107+
108+
To silence all progress updates, use:
109+
110+
```r
111+
handlers("void")
112+
```
113+
114+
115+
106116
## Support for progressr elsewhere
107117

108118
Note that progression updates by **progressr** is designed to work out of the box for any _sequential_ iterator framework in R. Below is an set of examples for the most common ones.
@@ -319,7 +329,7 @@ To debug progress updates, use:
319329

320330

321331

322-
[progressr]: https://github.com/HenrikBengtsson/progressr/
332+
[progressr]: https://cran.r-project.org/package=progressr
323333
[beepr]: https://cran.r-project.org/package=beepr
324334
[progress]: https://cran.r-project.org/package=progress
325335
[purrr]: https://cran.r-project.org/package=purrr

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,16 @@ handlers("txtprogressbar", "beepr")
105105
```
106106

107107

108+
### Silence all progress
109+
110+
To silence all progress updates, use:
111+
112+
```r
113+
handlers("void")
114+
```
115+
116+
117+
108118
## Support for progressr elsewhere
109119

110120
Note that progression updates by **progressr** is designed to work out of the box for any _sequential_ iterator framework in R. Below is an set of examples for the most common ones.
@@ -321,7 +331,7 @@ To debug progress updates, use:
321331

322332

323333

324-
[progressr]: https://github.com/HenrikBengtsson/progressr/
334+
[progressr]: https://cran.r-project.org/package=progressr
325335
[beepr]: https://cran.r-project.org/package=beepr
326336
[progress]: https://cran.r-project.org/package=progress
327337
[purrr]: https://cran.r-project.org/package=purrr

0 commit comments

Comments
 (0)