Skip to contents

Get Parameters

Source: R/params.R
get_parameters.Rd

This function retrieves the list of parameters and saves a copy of the parameter file (of type .yaml) to the specified output path.

Usage

get_parameters(out_path = tempdir(), iwindow = FALSE)

Arguments

out_path

character. The output path where the parameter file will be copied. The default is a temporary directory tempdir()

iwindow

logical. If window = TRUE, this will prompt the user to select the output directory using a file chooser window. The default value is FALSE.

Value

character. The path to the copied parameter file.

Details

Using this configuration where the parameters are structurally listed in a yaml file is an alternative method used in the sensitivity_analysis() function. Once the parameter.yaml is saved in a local directory, the user can modify each parameter value, save this file with the changes, and get the new parameters back in R with set_parameters().

Note that the sean() or msean() function will require to directly list the parameters within the function as it is typical in other R packages.

See also

set_parameters()

Examples

get_parameters()
#> [1] "/var/folders/r5/zggvft9d3yn5kh51wqp78rd00000gn/T//RtmpxBxXtP/parameters.yaml"
get_parameters(out = tempdir())
#> [1] "/var/folders/r5/zggvft9d3yn5kh51wqp78rd00000gn/T//RtmpxBxXtP/parameters.yaml"