options.help: Options Help

View source: R/options.R

options.helpR Documentation

Options Help

Description

Prints information for each requested option (or all options if options is NULL).

Usage

options.help(options = NULL, template_path = NULL)

Arguments

options

[character, optional] A single option name (dot-separated) or a character vector thereof. If NULL, prints all options from the template.

template_path

[character, optional] Path to the template YAML file. Defaults to PATHS$FILE_OPTIONS_TEMPLATE.

Value

Invisibly returns NULL, printing the requested information to the console.


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