options.load: Load user options
In artma: Automatic Replication Tools for Meta-Analysis

options.load

R Documentation

Load user options

Description

Load user options by their name and return them as a list.

Usage

options.load(
  options_file_name = NULL,
  options_dir = NULL,
  create_options_if_null = TRUE,
  load_with_prefix = TRUE,
  should_validate = TRUE,
  should_set_to_namespace = FALSE,
  should_return = TRUE
)

Arguments

`options_file_name`	[character, optional] Name of the options to load, including the .yaml suffix. Defaults to `NULL`.
`options_dir`	[character, optional] Path to the folder in which to look for user options files. Defaults to `NULL`.
`create_options_if_null`	[logical, optional] If set to TRUE and the options file name is set to NULL, the function will prompt the user to create a new options file. Defaults to TRUE.
`load_with_prefix`	[logical, optional] Whether the options should be loaded with the package prefix. Defaults to TRUE.
`should_validate`	[logical, optional] Whether the options should be validated after loading. Defaults to TRUE.
`should_set_to_namespace`	[logical, optional] Whether the options should be set in the options() namespace. Defaults to TRUE.
`should_return`	[logical, optional] Whether the function should return the list of options. Defaults to FALSE.

Details

In case the options name is not passed, the function will attempt to load the current options configuration. If none is found, it will then attempt to load the default options. If that fails too, an error is raised.