options: Scipiper session options

In aappling-usgs/scipiper: Support functions for ushering data through a scientific workflow

Description

Several session-level options are stored in R's .Options object.

Details

scipiper.remake_file

File path of the main remake YAML file for a project. Used as the default for the remake_file argument in many functions.

scipiper.dry_put

Logical, default FALSE. If TRUE, calls to s3_put or gd_put won't actually push anything to S3 or Google Drive; they'll just pretend they've done it.

scipiper.s3_config_file

File path to a configuration file for an Amazon S3 bucket. Used as the default for the s3_config_file argument in many functions (usually those prefixed with s3_).

scipiper.gd_config_file

File path to a configuration file for a Google Drive folder. Used as the default for the gd_config_file argument in many functions (usually those prefixed with gd_).

scipiper.ind_ext

The indicator file extension to recognize, i.e., the final file extension of files for which is_ind_file() should return TRUE and which as_ind_file should append to the data file name. Used as the default for the ind_ext argument in many functions.'

Examples

# see what's already there
getOption('scipiper.remake_file') # 'remake.yml'
getOption('scipiper.gd_config_file') # "lib/cfg/gd_config.yml"
getOption('scipiper.s3_config_file') # "lib/cfg/s3_config.yml"
getOption('scipiper.ind_ext') #'ind'
.Options[grep('scipiper', names(.Options), value=TRUE)] # list all scipiper options

# change the options - these commands can be placed in your project's .Rprofile
# file if you want them to be reapplied in every R session for the project
options('scipiper.ind_ext'='st', 'scipiper.remake_file'='remake.yaml')

aappling-usgs/scipiper documentation built on Aug. 1, 2020, 3:11 p.m.