ctsem (version 3.2.1)

ctStanKalman: Get Kalman filter estimates from a ctStanFit object

Description

Get Kalman filter estimates from a ctStanFit object

Usage

ctStanKalman(
  fit,
  nsamples = NA,
  collapsefunc = NA,
  cores = 2,
  standardisederrors = FALSE,
  subjectpars = FALSE,
  indvarstates = FALSE,
  ...
)

Arguments

fit

fit object from ctStanFit.

nsamples

either NA (to extract all) or a positive integer from 1 to maximum samples in the fit.

collapsefunc

function to apply over samples, such as mean

cores

Integer number of cpu cores to use. Only needed if savescores was set to FALSE when fitting.

standardisederrors

If TRUE, computes standardised errors for prior, upd, smooth conditions.

subjectpars

if TRUE, state estimates are not returned, instead, predictions of each subjects parameters are returned, for parameters that had random effects specified.

indvarstates

if TRUE, do not remove indvarying states from output

...

additional arguments to collpsefunc.

Value

list containing Kalman filter elements, each element in array of iterations, data row, variables. llrow is the log likelihood for each row of data.

Examples

# NOT RUN {
if (!exists("ctstantestfit")) example(ctstantestfit)
k=ctStanKalman(ctstantestfit,subjectpars=T,collapsefunc=mean)
# }