plot.ctsmTMB.pred: Plot of k-step predictions from a ctsmTMB prediction object

In ctsmTMB: Continuous Time Stochastic Modelling using Template Model Builder

Plot of k-step predictions from a ctsmTMB prediction object

Description

Plot of k-step predictions from a ctsmTMB prediction object

Usage

## S3 method for class 'ctsmTMB.pred'
plot(
  x,
  y,
  k.ahead = unique(x[["states"]][["k.ahead"]]),
  state.name = NULL,
  type = "states",
  against = NULL,
  ...
)

Arguments

x	a ctsmTMB.pred object
y	not used
k.ahead	an integer indicating which k-ahead predictions to plot
state.name	a string indicating which states to plot
type	one of 'states' or 'observations', to plot
against	name of an observations to plot predictions against
...	additional arguments

Value

A plot of predicted states

Examples

library(ctsmTMB)
model <- ctsmTMB$new()

# create model
model$addSystem(dx ~ theta * (mu+u-x) * dt + sigma_x*dw)
model$addObs(y ~ x)
model$setVariance(y ~ sigma_y^2)
model$addInput(u)
model$setParameter(
  theta   = c(initial = 1, lower=1e-5, upper=50),
  mu      = c(initial=1.5, lower=0, upper=5),
  sigma_x = c(initial=1, lower=1e-10, upper=30),
  sigma_y = 1e-2
)
model$setInitialState(list(1,1e-1))

# fit model to data
fit <- model$estimate(Ornstein)

# perform moment predictions
pred <- model$predict(Ornstein)

# plot the k.ahead=10 predictions
plot(pred, against="y.data")


# plot filtered states
plot(fit, type="states", against="y")

ctsmTMB documentation built on April 12, 2025, 1:45 a.m.