prdframe {dMod}

Prediction frame

Description

A prediction frame is used to store a model prediction in a matrix. The columns of the matrix are "time" and one column per state. The prediction frame has attributes "deriv", the matrix of sensitivities with respect to "outer parameters" (see P), an attribute "sensitivities", the matrix of sensitivities with respect to the "inner parameters" (the model parameters, left-hand-side of the parameter transformation) and an attributes "parameters", the parameter vector of inner parameters to produce the prediction frame.

Prediction frames are usually the constituents of prediction lists (prdlist). They are produced by Xs, Xd or Xf. When you define your own prediction functions, see P2X in prdfn, the result should be returned as a prediction frame.

Usage

prdframe(
  prediction = NULL,
  deriv = NULL,
  sensitivities = NULL,
  parameters = NULL
)

Arguments

prediction

matrix of model prediction

deriv

matrix of sensitivities wrt outer parameters

sensitivities

matrix of sensitivitie wrt inner parameters

parameters

names of the outer paramters

Value

Object of class prdframe, i.e. a matrix with other matrices and vectors as attributes.