fritools (version 3.3.0)

set_options: Set Options For Packages

Description

A convenience function for options.

Usage

set_options(..., package_name = .packages()[1], overwrite = TRUE)

Arguments

...

See options.

package_name

The package's name.

overwrite

[boolean(1)] Overwrite options already set?

Value

Invisibly TRUE.

See Also

Other option functions: get_options(), is_force()

Examples

# NOT RUN {
options("cleanr" = NULL)
defaults <- list(max_file_width = 80, max_file_length = 300,
                 max_lines = 65, max_lines_of_code = 50,
                 max_num_arguments = 5, max_nesting_depth = 3,
                 max_line_width = 80, check_return = TRUE)

set_options(package_name = "cleanr", defaults)
getOption("cleanr")
set_options(package_name = "cleanr", list(max_line_width = 3,
            max_lines = "This is nonsense!"))
set_options(package_name = "cleanr", check_return = NULL, max_lines = 4000)
get_options(package_name = "cleanr")
# }