e2ep_get_parmdoc {StrathE2EPolar} | R Documentation

## Get documentation on the parameters in the model.

### Description

Provides access to documentation on the parameters in the model in the form of a dataframe.

### Usage

    e2ep_get_parmdoc(selection = "SENS", id = 9)

### Arguments

`selection` | Text string from a list identifying the level of parameters to be listed. Select from: "MC", "SENS", Remember to include the phrase within "" quotes (default = "SENS")
`id` | Integer value denoting the class of parameters details to be downloaded. Choose from: 0 = fitted ecology, 1 = fixed ecology, 2 = fishing fleet, 3 = harvest ratios, 4 = environmental drivers, 5 = physical configuration, 9 = all (default = 9). Options 2-5 not available with "MC".

### Details

There are two levels of parameters for the model - the raw input parameters as extracted from the parameter csv files, and an expanded set of parameters, derive from the raw values, which are injected into the the model run.

The Monte Carlo simulation function in the package acts on the raw ecology model parameters, jigging each by a a random increment, to generate test parameter sets. The ecology model parameters are divided into fixed and fitted subsets based on whether they are available for optimization or not.

The Global Sensitivity analysis function in the package acts on the expanded parameter set. As well as fixed and fitted ecology parameters, the expanded set includes the physical setup parameters, fishing fleet parameters, harvest ratios, and environmental drivers.

This function downloads documentation on the full range of parameters in the form of a dataframe which can be used to form labels in user-generated code. The parameters are identified by a numeric value linked to 6 different classes of parameter.

Note that the function does not supply the numeric values of parameters for any given model setup. These are available in the model definition object generated by the function e2e_read().

### Value

dataframe of parameter documentation.

### See Also

`e2ep_read`

### Examples

        parm_list <- e2ep_get_parmdoc("MC",0)   # Get documentation on the raw fitted ecology parameters used in the Monte Carlo function
        parm_list <- e2ep_get_parmdoc("SENS",9) # Get documentation on all parameters used in the sensitivity analysis function
        parm_list <- e2ep_get_parmdoc()         # Get documentation on all parameters used in the sensitivity analysis function

[Package StrathE2EPolar version 2.1.0 Index]