Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix a link to outselves in the README #132

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Fix a link to outselves in the README #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,11 @@ See the manual for details and other options.

## Usage with `purrr` iterators

If you prefer to do your iterative tasks using the `purrr` family of functional programming tools, rather than with `for` loops, there are two straightforward ways to add progress bars:
If you prefer to do your iterative tasks using the `purrr` family of functional programming tools, rather than with `for` loops, there are two straightforward ways to add progress bars:

1. Increment the ticks *in-line* when calling the `purrr` iterator.

2. Define the task and increment the ticks in a separate wrapper function.
2. Define the task and increment the ticks in a separate wrapper function.

***Option 1*** is concise for simple one-line tasks (*e.g.* requiring only a single function call), while ***Option 2*** is probably preferred for more complex multi-line tasks.

Expand Down Expand Up @@ -262,8 +262,8 @@ plyr::l_ply(
## C++ API

The package also provides a C++ API, that can be used with or
without Rcpp. See [the example package](https://github.com/r-lib/progress/blob/HEAD/tests/testthat/progresstest/src/test.cpp) that
is [included](https://github.com/r-lib/progress/blob/HEAD/tests/testthat/progresstest) within `progress`. Here is a short excerpt
without Rcpp. See [the example package](tests/testthat/progresstest/src/test.cpp) that
is [included](tests/testthat/progresstest) within `progress`. Here is a short excerpt
that shows how it works:

```CPP
Expand Down