GenerateParams: Generate a range combinations of paramter values

Description Usage Arguments Details Value Examples

Description

Generate all possible combinations of values in the input vectors and (optionally) write them to a file. Typically used when making scenarios for fitting parameters.

Usage

1
2
GenerateParams(..., write = FALSE, splits = NULL, replicates = NULL,
  expand = TRUE, path = NULL)

Arguments

...

numeric One or more vectors (usually made with seq and the length.out argument)

write

logical Should a file with the table be written to disk?

splits

numeric The number of files to split the scenarios into. (Optional). If not NULL the files gets written to disk.

replicates

numeric The number of replicates to run (Optional).

expand

logical Should we expand an n by n grid (TRUE, defalut) or should we just generate a list of parameter ranges provided (FALSE)?

path

character Path where ParameterValues.txt will be written to.

Details

This function is a modification of expand.grid from base.

Value

data.frame One column data.frame where each line is a text string with the config variable and its value

Examples

1
2
3
4
val = seq(1, 5, length.out = 5)
val2 = seq(10, 50, length.out = 5)
GenerateParams('GOOSE_MINFORAGEOPENNESS' = val,
'HUNTERS_MAXDENSITY' = val2, write = FALSE)

LDalby/ralmass documentation built on May 8, 2019, 5:48 p.m.