Skip to content

Commit b20e224

Browse files
tidy up [ci skip]
1 parent d275b7f commit b20e224

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

OVERVIEW.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Design motto:
2020
1. Set up a progressor with a certain number of steps:
2121
</p>
2222
<pre>
23-
p <- progressor(nsteps)
24-
p <- progressor(along = x)
23+
p &lt;- progressor(nsteps)
24+
p &lt;- progressor(along = x)
2525
</pre>
2626

2727
<p>
@@ -50,8 +50,8 @@ p("loading ...") # pass on a message
5050
<pre>
5151
handlers(global = TRUE)
5252

53-
y <- slow_sum(1:5)
54-
y <- slow_sum(6:10)
53+
y &lt;- slow_sum(1:5)
54+
y &lt;- slow_sum(6:10)
5555
</pre>
5656

5757
<p>
@@ -60,8 +60,8 @@ y <- slow_sum(6:10)
6060

6161
<pre>
6262
with_progress({
63-
y <- slow_sum(1:5)
64-
y <- slow_sum(6:10)
63+
y &lt;- slow_sum(1:5)
64+
y &lt;- slow_sum(6:10)
6565
})
6666
</pre>
6767

@@ -704,7 +704,6 @@ M: Added value 3
704704
[future.apply]: https://cran.r-project.org/package=future.apply
705705
[doParallel]: https://cran.r-project.org/package=doParallel
706706
[doFuture]: https://cran.r-project.org/package=doFuture
707-
[foreach]: https://cran.r-project.org/package=foreach
708707
[furrr]: https://cran.r-project.org/package=furrr
709708
[pbapply]: https://cran.r-project.org/package=pbapply
710709
[pbmcapply]: https://cran.r-project.org/package=pbmcapply

vignettes/progressr-intro.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
%\VignetteEngine{progressr::selfonly}
1010
-->
1111
<!-- DO NOT EDIT THIS FILE! Edit 'OVERVIEW.md' instead and then rebuild this file with 'make vigs' -->
12-
![Life cycle: experimental](imgs/lifecycle-maturing-blue.svg)
13-
1412
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.
1513

1614

@@ -33,8 +31,8 @@ Design motto:
3331
1. Set up a progressor with a certain number of steps:
3432
</p>
3533
<pre>
36-
p <- progressor(nsteps)
37-
p <- progressor(along = x)
34+
p &lt;- progressor(nsteps)
35+
p &lt;- progressor(along = x)
3836
</pre>
3937

4038
<p>
@@ -63,8 +61,8 @@ p("loading ...") # pass on a message
6361
<pre>
6462
handlers(global = TRUE)
6563

66-
y <- slow_sum(1:5)
67-
y <- slow_sum(6:10)
64+
y &lt;- slow_sum(1:5)
65+
y &lt;- slow_sum(6:10)
6866
</pre>
6967

7068
<p>
@@ -73,8 +71,8 @@ y <- slow_sum(6:10)
7371

7472
<pre>
7573
with_progress({
76-
y <- slow_sum(1:5)
77-
y <- slow_sum(6:10)
74+
y &lt;- slow_sum(1:5)
75+
y &lt;- slow_sum(6:10)
7876
})
7977
</pre>
8078

@@ -717,7 +715,6 @@ M: Added value 3
717715
[future.apply]: https://cran.r-project.org/package=future.apply
718716
[doParallel]: https://cran.r-project.org/package=doParallel
719717
[doFuture]: https://cran.r-project.org/package=doFuture
720-
[foreach]: https://cran.r-project.org/package=foreach
721718
[furrr]: https://cran.r-project.org/package=furrr
722719
[pbapply]: https://cran.r-project.org/package=pbapply
723720
[pbmcapply]: https://cran.r-project.org/package=pbmcapply

0 commit comments

Comments
 (0)