Skip to content

Suggest parallelly::availableCores() in mc.cores docs #218

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

Open
ms609-agent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Suggest parallelly::availableCores() in mc.cores docs #218

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions R/parallel.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
#' `"mc.cores"` option:
#'
#' ```r
#' options(mc.cores = parallel::detectCores()) # use all available cores
#' options(mc.cores = 4L) # or a fixed number
#' options(mc.cores = parallelly::availableCores()) # use all available cores
#' options(mc.cores = 4L) # or a fixed number
#' ```
#'
#' The default is `1` (single-threaded).
Expand Down
4 changes: 2 additions & 2 deletions R/tree_distance_info.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@
#' automatically. Control the number of threads with the `"mc.cores"` option:
#'
#' ```r
#' options(mc.cores = parallel::detectCores()) # use all cores
#' options(mc.cores = 4L) # or a fixed number
#' options(mc.cores = parallelly::availableCores()) # use all cores
#' options(mc.cores = 4L) # or a fixed number
#' ```
#'
#' Do **not** call [`StartParallel()`] for these functions: a registered
Expand Down
4 changes: 2 additions & 2 deletions man/StartParallel.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/TreeDistance.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading