Skip to contents

Extract the daily parameter names from a metabolism model.

Source: R/metab_model_interface.R, R/metab_model.get_param_names.R
get_param_names.Rd

A function in the metab_model_interface. Returns vectors of the required and optional daily metabolism parameters for the model.

Usage

get_param_names(metab_model, ...)

# S3 method for character
get_param_names(metab_model, ...)

# S3 method for metab_model
get_param_names(metab_model, ...)

Arguments

metab_model

A metabolism model object or model name for which to return the list of required and optional metabolism parameters.

...

Placeholder for future arguments

Value

Returns a list of two vectors, the names of the required and optional daily metabolism parameters, respectively.

Methods (by class)

  • character: This implementation is shared by many model types

  • metab_model: Lets you pass in a model object rather than a character string

See also

Other metab_model_interface: get_data_daily(), get_data(), get_fitting_time(), get_fit(), get_info(), get_params(), get_specs(), get_version(), predict_DO(), predict_metab()

Examples


# pass in a character string:
get_param_names(mm_name('mle', GPP_fun='satlight'))
#> $required
#> [1] "Pmax"       "alpha"      "ER.daily"   "K600.daily"
#> 
#> $optional
#> [1] "DO.mod.1"
#> 
get_param_names(mm_name('bayes'))
#> $required
#> [1] "GPP.daily"  "ER.daily"   "K600.daily"
#> 
#> $optional
#> [1] "DO.mod.1"
#> 
get_param_names(mm_name('Kmodel'))
#> $required
#> [1] "K600.daily"
#> 
#> $optional
#> NULL
#> 
get_param_names(mm_name('night'))
#> $required
#> [1] "ER.daily"   "K600.daily"
#> 
#> $optional
#> [1] "DO.mod.1"
#> 
get_param_names(mm_name('sim'))
#> $required
#> [1] "K600.daily"     "GPP.daily"      "ER.daily"       "err.obs.sigma" 
#> [5] "err.obs.phi"    "err.proc.sigma" "err.proc.phi"  
#> 
#> $optional
#> [1] "discharge.daily" "DO.mod.1"       
#> 

# or pass in a metab_model object:
dat <- data_metab('1','30')
get_param_names(metab(specs(mm_name('mle', ER_fun='q10temp')), data=dat))
#> $required
#> [1] "GPP.daily"  "ER20"       "K600.daily"
#> 
#> $optional
#> [1] "DO.mod.1"
#> 
get_param_names(metab(specs('night'), data=dat))
#> $required
#> [1] "ER.daily"   "K600.daily"
#> 
#> $optional
#> [1] "DO.mod.1"
#> 
get_param_names(metab(specs('sim'), data=dat))
#> $required
#> [1] "K600.daily"     "GPP.daily"      "ER.daily"       "err.obs.sigma" 
#> [5] "err.obs.phi"    "err.proc.sigma" "err.proc.phi"  
#> 
#> $optional
#> [1] "discharge.daily" "DO.mod.1"       
#>