Functions implemented by compatible metabolism models — metab_model

Metabolism models in streamMetabolizer all implement a common set of core functions. These functions are conceptually packaged as the metab_model_interface defined here.

Functions in the interface

show(metab_model) displays the model.
get_params() returns a data frame of model parameters.
get_param_names() returns required and optional parameter names.
predict_metab() returns a data frame of metabolism predictions.
predict_DO() returns a data frame of dissolved oxygen predictions.
get_fit() returns the internal fitted model.
get_fitting_time() returns the model fitting time.
get_info() returns user-supplied metadata.
get_specs() returns model specifications.
get_data() returns the subdaily fitting data.
get_data_daily() returns the daily fitting data.
get_version() returns the package version used to fit the model.

Examples

methods(class = "metab_model")
#>  [1] get_data         get_data_daily   get_fit          get_fitting_time
#>  [5] get_info         get_param_names  get_params       get_specs       
#>  [9] get_version      predict_DO       predict_metab    show            
#> see '?methods' for accessing help and source code