|
22 | 22 | #' f <- future({ expr }) ## Launch a future with large objects |
23 | 23 | #' ``` |
24 | 24 | #' |
25 | | -#' @section Settings moved to the 'parallelly' package: |
26 | | -#' Several functions have been moved to the \pkg{parallelly} package: |
27 | | -#' |
28 | | -#' * [parallelly::availableCores()] |
29 | | -#' * [parallelly::availableWorkers()] |
30 | | -#' * [parallelly::makeClusterMPI()] |
31 | | -#' * [parallelly::makeClusterPSOCK()] |
32 | | -#' * [parallelly::makeNodePSOCK()] |
33 | | -#' * [parallelly::supportsMulticore()] |
34 | | -#' |
35 | | -#' The options and environment variables controlling those have been adjusted |
36 | | -#' accordingly to have different prefixes. |
37 | | -#' For example, option \option{future.fork.enable} has been renamed to |
38 | | -#' \option{parallelly.fork.enable} and the corresponding environment variable |
39 | | -#' \env{R_FUTURE_FORK_ENABLE} has been renamed to |
40 | | -#' \env{R_PARALLELLY_FORK_ENABLE}. |
41 | | -#' For backward compatibility reasons, the \pkg{parallelly} package will |
42 | | -#' support both versions for a long foreseeable time. |
43 | | -#' See the [parallelly::parallelly.options] page for the settings. |
44 | | -#' |
45 | 25 | #' @section Options for controlling futures: |
46 | 26 | #' \describe{ |
47 | 27 | #' \item{\option{future.plan}:}{(character string or future function) Default future backend used unless otherwise specified via [plan()]. This will also be the future plan set when calling `plan("default")`. If not specified, this option may be set when the \pkg{future} package is _loaded_ if command-line option `--parallel=ncores` (short `-p ncores`) is specified; if `ncores > 1`, then option \option{future.plan} is set to `multisession` otherwise `sequential` (in addition to option \option{mc.cores} being set to `ncores`, if `ncores >= 1`). (Default: `sequential`)} |
|
165 | 145 | #' \item{\option{future.output.windows.reencode}:}{(logical) Enable or disable re-encoding of UTF-8 symbols that were incorrectly encoded while captured. In R (< 4.2.0) and on older versions of MS Windows, R cannot capture UTF-8 symbols as-is when they are captured from the standard output. For examples, a UTF-8 check mark symbol (`"\u2713"`) would be relayed as `"<U+2713>"` (a string with eight ASCII characters). Setting this option to `TRUE` will cause `value()` to attempt to recover the intended UTF-8 symbols from `<U+nnnn>` string components, if, and only if, the string was captured by a future resolved on MS Windows. (Default: `TRUE`)} |
166 | 146 | #' } |
167 | 147 | #' |
168 | | -#' See also [parallelly::parallelly.options]. |
169 | | -#' |
170 | 148 | #' |
171 | 149 | #' @section Options for demos: |
172 | 150 | #' \describe{ |
|
202 | 180 | #' Similarly, if `R_FUTURE_GLOBALS_MAXSIZE="50000000"`, then option |
203 | 181 | #' \option{future.globals.maxSize} is set to `50000000` (numeric). |
204 | 182 | #' |
| 183 | +#' |
| 184 | +#' @section Options moved to the 'parallelly' package: |
| 185 | +#' Several functions have been moved to the \pkg{parallelly} package: |
| 186 | +#' |
| 187 | +#' * [parallelly::availableCores()] |
| 188 | +#' * [parallelly::availableWorkers()] |
| 189 | +#' * [parallelly::makeClusterMPI()] |
| 190 | +#' * [parallelly::makeClusterPSOCK()] |
| 191 | +#' * [parallelly::makeNodePSOCK()] |
| 192 | +#' * [parallelly::supportsMulticore()] |
| 193 | +#' |
| 194 | +#' The options and environment variables controlling those have been adjusted |
| 195 | +#' accordingly to have different prefixes. |
| 196 | +#' For example, option \option{future.fork.enable} has been renamed to |
| 197 | +#' \option{parallelly.fork.enable} and the corresponding environment variable |
| 198 | +#' \env{R_FUTURE_FORK_ENABLE} has been renamed to |
| 199 | +#' \env{R_PARALLELLY_FORK_ENABLE}. |
| 200 | +#' For backward compatibility reasons, the \pkg{parallelly} package will |
| 201 | +#' support both versions for a long foreseeable time. |
| 202 | +#' See the [parallelly::parallelly.options] page for the settings. |
| 203 | +#' |
| 204 | +#' |
205 | 205 | #' @examples |
206 | 206 | #' # Allow at most 5 MB globals per futures |
207 | 207 | #' options(future.globals.maxSize = 5e6) |
|
0 commit comments