SwitchrParam-class

SwitchrParam

A contstructor for a SwitchrParam object representing a number of common
parameters understood by the switchr framework

Provides an abstraction for managing, installing,
and switching between sets of installed R packages. This allows users to
maintain multiple package libraries simultaneously, e.g. to maintain
strict, package-version-specific reproducibility of many analyses, or
work within a development/production release paradigm. Introduces a
generalized package installation process which supports multiple repository
and non-repository sources and tracks package provenance.

Gabriel Becker

switchr

Installing, Managing, and Switching Between Distinct Sets of
Installed Packages

SwitchrParam-class function

<dl><dt>logfun</dt>
<dd>The function to be called to write to logs</dd>
<dt>shell_init</dt>
<dd>A character containing the location of a shell script to
be sourced before any system commands.</dd>
<dt>archive_timing</dt>
<dd>The timeout after downloading a package from the CRAN Archive.</dd>
<dt>archive_retries</dt>
<dd>Number of times to retry retrieving a package from the CRAN Archive.</dd>
<dt>dl_method</dt>
<dd>The download method to use when retrieve package
source files. See <code><a href="/link/download.file?package=switchr&version=0.14.8" data-mini-rdoc="switchr::download.file">download.file</a></code> If none is specified,
the method defaults to "curl" if the RCurl package is installed and "auto" otherwise.</dd>
<dt>shell_timing</dt>
<dd>numeric. The numer of seconds to wait between certain shell commands.
Defaults to 1, this should only need to be changed in the case of, e.g., networked drive latency issues.</dd></dl>

Arguments

Author

SwitchrParam — SwitchrParam-class

<dl>

<dt>logfun</dt>
<dd>The function to be called to write to logs</dd>


<dt>shell_init</dt>
<dd>A character containing the location of a shell script to
be sourced before any system commands.</dd>


<dt>archive_timing</dt>
<dd>The timeout after downloading a package from the CRAN Archive.</dd>


<dt>archive_retries</dt>
<dd>Number of times to retry retrieving a package from the CRAN Archive.</dd>


<dt>dl_method</dt>
<dd>The download method to use when retrieve package
source files. See <code><a href='https://rdrr.io/r/utils/download.file.html'>download.file</a></code> If none is specified,
the method defaults to "curl" if the RCurl package is installed and "auto" otherwise.</dd>


<dt>shell_timing</dt>
<dd>numeric. The numer of seconds to wait between certain shell commands.
Defaults to 1, this should only need to be changed in the case of, e.g., networked drive latency issues.</dd>

</dl>

SwitchrParam-class: SwitchrParam

Description

Usage

Value

Arguments

Author