SwitchrParam: SwitchrParam

In switchr: Installing, Managing, and Switching Between Distinct Sets of Installed Packages

SwitchrParam

Description

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

Usage

SwitchrParam(
  logfun = function(...) NULL,
  shell_init = character(),
  archive_timing = 2,
  archive_retries = 2,
  dl_method,
  shell_timing = 1
)

Arguments

logfun	The function to be called to write to logs
shell_init	A character containing the location of a shell script to be sourced before any system commands.
archive_timing	The timeout after downloading a package from the CRAN Archive.
archive_retries	Number of times to retry retrieving a package from the CRAN Archive.
dl_method	The download method to use when retrieve package source files. See download.file If none is specified, the method defaults to "curl" if the RCurl package is installed and "auto" otherwise.
shell_timing	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.

Value

A SwitchrParam object.

Author(s)

Gabriel Becker

switchr documentation built on March 31, 2023, 5:13 p.m.