returns an id representing a model run — get.run.id • PEcAn.utils

Provides a consistent method of naming runs; for use in model input files and indices

get.run.id(run.type, index, trait = NULL, pft.name = NULL, site.id = NULL)

Arguments

run.type: character, can be any character; currently 'SA' is used for sensitivity analysis, 'ENS' for ensemble run.
index: unique index for different runs, e.g. integer counting members of an ensemble or a quantile used to which a trait has been perturbed for sensitivity analysis
trait: name of trait being sampled (for sensitivity analysis)
pft.name: name of PFT (value from pfts.names field in database)
site.id: optional site id .This is could be necessary for multisite write=false ensembles.

Value

id representing a model run

Author

Carl Davidson, David LeBauer

Examples

get.run.id('ENS', left.pad.zeros(1, 5))
#> [1] "ENS-00001"
get.run.id('SA', round(qnorm(-3),3), trait = 'Vcmax')
#> Warning: NaNs produced
#> [1] "SA-Vcmax-NaN"