artma (version 0.2.1)

options.modify: Modify User Options

Description

Modify an existing user options file with new values.

Usage

options.modify(
  options_file_name = NULL,
  options_dir = NULL,
  template_path = NULL,
  user_input = list(),
  should_validate = TRUE
)

Value

NULL

Arguments

options_file_name

[character, optional] Name of the user options file to modify, including the suffix.

options_dir

[character, optional] Full path to the folder that contains user options files. If not provided, the default folder is chosen. Defaults to NULL.

template_path

[character, optional] Full path to the options template file. Defaults to NULL.

user_input

[list, optional] A named list of user-supplied values for these options. If NULL or missing entries exist, the function will prompt the user via readline() (for required entries) or use defaults (for optional ones).

should_validate

[logical, optional] If TRUE, validate the modified options file against the template. Defaults to TRUE.