summary.ctsmTMB.fit: Basic summary of ctsmTMB fit object

View source: R/methods.R

summary.ctsmTMB.fitR Documentation

Basic summary of ctsmTMB fit object

Description

Basic summary of ctsmTMB fit object

Usage

## S3 method for class 'ctsmTMB.fit'
summary(object, correlation = FALSE, ...)

Arguments

object

a ctsmTMB fit object

correlation

boolean indicating whether or not to display the parameter correlation structure

...

additional arguments

Value

a summary of the estimated ctsmTMB model fit

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)

# print model summary
summary(fit, correlation=TRUE)

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