getExpression() on ‘cluster’ future could under some circumstances call local() on the global search path rather than base::local() as intended. For example, if a package that exports its own local() function was attached, then that would be called instead, often leading to a hard to troubleshoot error.getExpression() on ‘cluster’ future could under some circumstances call local() on the global search path rather than base::local() as intended. For example, if a package that exports its own local() function was attached, then that would be called instead, often leading to a hard-to-troubleshoot error.
(character string) Controls whether the identified globals should be scanned for so called references (e.g. external pointers and connections) or not. It is unlikely that another R process ("worker") can use a global that uses a internal reference of the master R process - we call such objects non-exportable globals. +
(character string) Controls whether the identified globals should be scanned for so called references (e.g. external pointers and connections) or not. It is unlikely that another R process ("worker") can use a global that uses a internal reference of the master R process---we call such objects non-exportable globals.
If this option is "error", an informative error message is produced if a non-exportable global is detected.
If "warning", a warning is produced, but the processing will continue; it is likely that the future will be resolved with a run-time error unless processed in the master R process (e.g. plan(sequential) and plan(multicore)).
If "ignore", no scan is performed.
@@ -259,7 +259,7 @@
(character vector or a logical) Specifies zero of more future startup scripts to be sourced when the future package is attached. It is only the first existing script that is sourced. If none of the specified files exist, nothing is sourced - there will be neither a warning nor an error. +
(character vector or a logical) Specifies zero of more future startup scripts to be sourced when the future package is attached. It is only the first existing script that is sourced. If none of the specified files exist, nothing is sourced---there will be neither a warning nor an error.
If this option is not specified, environment variable R_FUTURE_STARTUP_SCRIPT is considered, where multiple scripts may be separated by either a colon (:) or a semicolon (;). If neither is set, or either is set to TRUE, the default is to look for a .future.R script in the current directory and then in the user's home directory. To disable future startup scripts, set the option or the environment variable to FALSE. Importantly, this option is always set to FALSE if the future package is loaded as part of a future expression being evaluated, e.g. in a background process. In order words, they are sourced in the main R process but not in future processes. (Default: TRUE in main R process and FALSE in future processes / during future evaluation)
The maximum allowed total size (in bytes) of globals - for +
The maximum allowed total size (in bytes) of globals---for the purpose of preventing too large exports / transfers happening by mistake. If the total size of the global objects are greater than this limit, an informative error message is produced. If diff --git a/reference/plan.html b/reference/plan.html index 6cda1c06..1b2dc907 100644 --- a/reference/plan.html +++ b/reference/plan.html @@ -184,25 +184,25 @@
The evaluation function (or name of it) to use -for resolving a future. If NULL, then the current strategy is returned.
NULL, then the current strategy is returned.Additional arguments overriding the default arguments
of the evaluation function. Which additional arguments are supported
depends on what evaluation function is used, e.g. several support
-argument workers but not all. For details, see the individual
+argument workers but not all. For details, see the individual
functions of which some are linked to below.
If TRUE, the strategy expression is
+
If TRUE, the strategy expression is
substitute():d, otherwise not.
(internal) If TRUE, then attempts to set a strategy
-that is the same as what is currently in use, will skipped.
Please refrain from modifying the future strategy inside your packages /
-functions, i.e. do not call plan() in your code. Instead, leave
-the control on what backend to use to the end user. This idea is part of
-the core philosophy of the future framework - as a developer you can never
-know what future backends the user have access to. Moreover, by not making
+functions, i.e. do not call plan() in your code. Instead, leave
+the control on what backend to use to the end user. This idea is part of
+the core philosophy of the future framework---as a developer you can never
+know what future backends the user have access to. Moreover, by not making
any assumptions about what backends are available, your code will also work
automatically with any new backends developed after you wrote your code.
If you think it is necessary to modify the future strategy within a @@ -305,17 +305,17 @@
When writing scripts or vignettes that uses futures, try to place any
-call to plan() as far up (as early on) in the code as possible.
+
When writing scripts or vignettes that use futures, try to place any
+call to plan() as far up (i.e. as early on) in the code as possible.
This will help users to quickly identify where the future plan is set up
and allow them to modify it to their computational resources.
Even better is to leave it to the user to set the plan() prior to
source():ing the script or running the vignette.
If a .future.R exists in the current directory and / or in
the user's home directory, it is sourced when the future package is
-loaded. Because of this, the .future.R file provides a
+loaded. Because of this, the .future.R file provides a
convenient place for users to set the plan().
-This behavior can be controlled via an R option - see
+This behavior can be controlled via an R option---see
future options for more details.