Get Parameters

Source:R/params.R

get_parameters.Rd

This function retrieves the list of parameters and saves a copy ofthe 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 becopied. The default is a temporary directorytempdir()
iwindow: logical. If window =TRUE, this will prompt the user to select the outputdirectory using a file chooser window. The default value isFALSE.

Value

character. The path to the copied parameter file.

Details

Using this configuration where the parameters are structurally listed ina yaml file is an alternative method used in thesensitivity_analysis()function. Once the parameter.yaml is saved in a local directory, the user canmodify each parameter value, save this file with the changes, and get thenew parameters back in R withset_parameters().

Note that thesean() ormsean() function will require to directly listthe parameters within the function as it is typical in other R packages.

Examples

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