predict_ttr {TTR.PGM}R Documentation

Make a prediction from a fitted model

Description

Make a prediction from a fitted TTR.PGM model.

Usage

predict_ttr(parms, Model, Data, new.input = NULL, options = NULL, optim = NULL)

Arguments

parms

A vector of parameters compatible with the data object 'Data' and the user defined Model function

Model

A user defined Model function that accepts 'parms' and 'Data' as input

Data

A Data object as produced by make_data()

new.input

If the prediction should use different forcing data from 'Data', this can be an input object as returned by get_input()

options

If the prediction should use different options from 'Data', this can be supplied as an options list as required by make_data()

optim

If the user defined Model function tests for 'optim' in options, this can be used to set it. Defaults to the string "no"

Details

predict_ttr() returns the data object specified when the option 'Data$options$optim' in the user defined Model is set to "no". See the vignette for an example.

Value

The prediction as specified in the user defined Model function


[Package TTR.PGM version 1.0.0 Index]