init_package: Checks and sets environmental variables

Description Usage Arguments Details

View source: R/utils.R

Description

The package relies on several environmental variables. On load the package tests whether the variables are set, if not it prompts for setting them. The function 'init_package' can be also called within the session to overwrite the current setting.

Usage

1
2
init_package(R_DATA_PATH = NULL,
  renviron_path = Sys.getenv("R_ENVIRON_USER"))

Arguments

R_DATA_PATH

Path to "big" data

renviron_path

Path to .Renviron file

Details

The function simply writes the environmental variables into .Renviron file (typically in the home directory). If you encounter problems with calling the function or during package load, try to alter .Renviron file manually.

The contents of the .Renviron can be e.g.

R_DATA_PATH='/home/DATA'

Currently implemented are:

'R_DATA_PATH'

The path to store big data. Only local storage implemented at the moment.


hanel/rcm2019 documentation built on Nov. 10, 2019, 9:35 p.m.