options.list: List available user options

In artma: Automatic Replication Tools for Meta-Analysis

List available user options

Description

Retrieves the list of the existing options files and returns their names as a character vector. By default, this retrieves the names of the files including the yaml suffix, but can be modified to retrieve options verbose names instead.

Usage

options.list(options_dir = NULL, should_return_verbose_names = FALSE)

Arguments

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.
should_return_verbose_names	[logical, optional] If set to TRUE, the custom names of each of the options files are read and returned instead of file names. Defaults to FALSE.

Value

[vector, character] A character vector with the names of the options available.

artma documentation built on April 13, 2025, 9:08 a.m.