getOption2

Gets an R Option or an Environment Variable

internal

Utility functions that enhance the 'parallel' package and support the built-in parallel backends of the 'future' package.  For example, availableCores() gives the number of CPU cores available to your R process as given by the operating system, 'cgroups' and Linux containers, R options, and environment variables, including those set by job schedulers on high-performance compute clusters. If none is set, it will fall back to parallel::detectCores(). Another example is makeClusterPSOCK(), which is backward compatible with parallel::makePSOCKcluster() while doing a better job in setting up remote cluster workers without the need for configuring the firewall to do port-forwarding to your local computer.

Henrik Bengtsson

parallelly

Enhancing the 'parallel' Package

getOption2 function

<dl><dt>name</dt>
<dd>(character string) The name of the R option.</dd>
<dt>default</dt>
<dd>(a single object) The value to be returned if neither
the R option nor the environment variable is set. If the environment
variable is set, its value is coerced to the same type as <code>default</code>.</dd>
<dt>envvar</dt>
<dd>(character string) The name of the environment variable.
If not set, or NULL, then the name is automatically constructed from
the upper-case version of argument <code>name</code> with periods (<code>.</code>) substituted
by underscores (<code>_</code>) and prefixed with <code>R_</code>, e.g. with <code>"abc.debug"</code>
becomes <code>R_ABC_DEBUG</code>.</dd></dl>

Arguments

Gets an R Option or an Environment Variable — getOption2

<dl>

<dt>name</dt>
<dd>(character string) The name of the R option.</dd>


<dt>default</dt>
<dd>(a single object) The value to be returned if neither
the R option nor the environment variable is set. If the environment
variable is set, its value is coerced to the same type as <code>default</code>.</dd>


<dt>envvar</dt>
<dd>(character string) The name of the environment variable.
If not set, or NULL, then the name is automatically constructed from
the upper-case version of argument <code>name</code> with periods (<code>.</code>) substituted
by underscores (<code>_</code>) and prefixed with <code>R_</code>, e.g. with <code>"abc.debug"</code>
becomes <code>R_ABC_DEBUG</code>.</dd>

</dl>

getOption2: Gets an R Option or an Environment Variable

Description

Usage

Value

Arguments