ctModel: Define a ctsem model
In ctsem: Continuous Time Structural Equation Modelling
ctModel R Documentation
Define a ctsem model
Description
This function is used to specify a continuous time structural equation model,
which can then be fit to data with function ctStanFit.
Usage
ctModel(
LAMBDA,
type = "omx",
n.manifest = "auto",
n.latent = "auto",
Tpoints = NULL,
manifestNames = "auto",
latentNames = "auto",
id = "id",
time = "time",
silent = FALSE,
T0VAR = "auto",
T0MEANS = "auto",
MANIFESTMEANS = "auto",
MANIFESTVAR = "auto",
DRIFT = "auto",
CINT = "auto",
DIFFUSION = "auto",
n.TDpred = "auto",
TDpredNames = "auto",
n.TIpred = "auto",
TIpredNames = "auto",
tipredDefault = TRUE,
TRAITVAR = NULL,
T0TRAITEFFECT = NULL,
MANIFESTTRAITVAR = NULL,
TDPREDMEANS = "auto",
TDPREDEFFECT = "auto",
T0TDPREDCOV = "auto",
TDPREDVAR = "auto",
TRAITTDPREDCOV = "auto",
TDTIPREDCOV = "auto",
TIPREDMEANS = "auto",
TIPREDEFFECT = "auto",
T0TIPREDEFFECT = "auto",
TIPREDVAR = "auto",
PARS = NULL,
startValues = NULL
)
Arguments
LAMBDA
n.manifest*n.latent loading matrix relating latent to manifest variables,
with latent processes 1:n.latent along the columns, and manifest variables
1:n.manifest in the rows.
type
character string. If 'omx' (default) configures model for maximum likelihood fitting with ctFit, using OpenMx.
If 'stanct' or 'standt' configures either continuous ('stanct') or discrete ('standt') time
model for Bayesian fitting with ctStanFit, using Stan.
n.manifest
Number of manifest indicators per individual at each measurement occasion / time point.
Manifest variables are included as the first element of the wide data matrix, with all the 1:n.manifest manifest variables
at time 1 followed by those of time 2, and so on.
n.latent
Number of latent processes.
Tpoints
For type='omx' only. Number of time points, or measurement occasions, in the data. This will generally be the maximum
number of time points for a single individual, but may be one extra if sample relative time intervals are used,
see ctIntervalise.
manifestNames
n.manifest length vector of manifest variable names as they appear in the data structure,
without any _Tx time point suffix that may be present in wide data. Defaults to Y1, Y2, etc.
latentNames
n.latent length vector of latent variable names
(used for naming parameters, defaults to eta1, eta2, etc).
id
character string denoting column name containing subject identification variables.
id data may be of any form, though will be coerced internally to an integer sequence rising from 1.
time
character string denoting column name containing timing data. Timing data must be numeric.
silent
Suppress all output to console.
T0VAR
lower triangular n.latent*n.latent cholesky matrix of latent process initial variance / covariance.
"auto" freely estimates all parameters.
T0MEANS
n.latent*1 matrix of latent process means at first time point, T0.
"auto" freely estimates all parameters.
MANIFESTMEANS
n.manifest*1 matrix of manifest intercept parameters.
"auto" frees all parameters.
MANIFESTVAR
lower triangular n.manifest*n.manifest cholesky matrix of variance / covariance
between manifests at each measurement occasion (i.e. measurement error / residual).
"auto" freely estimates variance parameters,
and fixes covariances between manifests to 0. "free" frees all values, including covariances.
DRIFT
n.latent*n.latent DRIFT matrix of continuous auto and cross effects,
relating the processes over time.
"auto" freely estimates all parameters.
CINT
n.latent * 1 matrix of latent process intercepts, allowing for non 0
asymptotic levels of the latent processes. Generally only necessary for additional trends and more complex dynamics.
"auto" fixes all parameters to 0.
DIFFUSION
lower triangular n.latent*n.latent cholesky matrix of diffusion process
variance and covariance (latent error / dynamic innovation).
"auto" freely estimates all parameters.
n.TDpred
Number of time dependent predictor variables in the dataset.
TDpredNames
n.TDpred length vector of time dependent predictor variable names,
as they appear in the data structure, without any _Tx time point suffix that may appear in wide data.
Default names are TD1, TD2, etc.
n.TIpred
Number of time independent predictors.
Each TIpredictor is inserted at the right of the data matrix, after the time intervals.
TIpredNames
n.TIpred length vector of time independent predictor variable names,
as they appear in the data structure. Default names are TI1, TI2, etc.
tipredDefault
Logical. TRUE sets any parameters with unspecified time independent
predictor effects to have effects estimated, FALSE fixes the effect to zero unless individually specified.
TRAITVAR
For type='omx' only. Either NULL, if no trait / unobserved heterogeneity effect,
or lower triangular n.latent*n.latent cholesky matrix of trait variance / covariance across subjects.
"auto" freely estimates all parameters.
T0TRAITEFFECT
For type='omx' only. Either NULL, if no trait / individual heterogeneity effect,
or lower triangular n.latent*n.latent cholesky matrix of initial trait variance / covariance.
"auto" freely estimates all parametrers, if the TRAITVAR matrix is specified.
MANIFESTTRAITVAR
For type='omx' only. Either NULL (default) if no trait variance / individual heterogeneity in the level of
the manifest indicators, otherwise a lower triangular n.manifest * n.manifest variance / covariance matrix.
Set to "auto" to include and free all parameters - but identification problems will arise if TRAITVAR is
also set.
TDPREDMEANS
For type='omx' only. (n.TDpred * (Tpoints - 1)) rows * 1 column matrix of time dependent predictor means.
If 'auto', the means are freely estimated. Otherwise,
the means for the Tpoints observations of your first time dependent predictor
are followed by those of TDpred 2, and so on.
TDPREDEFFECT
n.latent*n.TDpred matrix of effects from time dependent predictors to latent processes.
Effects from 1:n.TDpred columns TDpredictors go to 1:n.latent rows of latent processes.
"auto" freely estimates all parameters.
T0TDPREDCOV
For type='omx' only. n.latent rows * (Tpoints * n.TDpred) columns covariance matrix
between latents at T0 and time dependent predictors.
Default of "auto" restricts covariance to 0, which is consistent with covariance to other time points.
To freely estimate parameters, specify either 'free', or the desired matrix.
TDPREDVAR
For type='omx' only. lower triangular (n.TDpred * Tpoints) rows
* (n.TDpred * Tpoints) columns variance / covariance
cholesky matrix for time dependent predictors.
"auto" (default) freely estimates all parameters.
TRAITTDPREDCOV
For type='omx' only. n.latent rows * (n.TDpred*Tpoints) columns covariance matrix of
latent traits and time dependent predictors. Defaults to zeroes,
assuming predictors are independent of subjects baseline levels. When predictors depend on the subjects,
this should instead be set to 'free' or manually specified.
The Tpoints columns of the first preditor are followed by those of the second and so on.
Covariances with the trait variance of latent process 1 are specified in row 1, process 2 in row 2, etc.
"auto" (default) sets this matrix to zeroes, (if both traits and time dependent predictors exist, otherwise this matrix is set to NULL, and ignored in any case).
TDTIPREDCOV
For type='omx' only. (n.TDpred * Tpoints) rows * n.TIpred columns covariance
matrix between time dependent and time independent predictors.
"auto" (default) freely estimates all parameters.
TIPREDMEANS
For type='omx' only. n.TIpred * 1 matrix of time independent predictor means.
If 'auto', the means are freely estimated.
TIPREDEFFECT
For type='omx' only. n.latent*n.TIpred effect matrix of time independent predictors on latent processes.
"auto" freely estimates all parameters and generates starting values. TIPREDEFFECT parameters for type='stan' are estimated
by default on all subject level parameters, to restrict this,
manually edit the model object after creation.
T0TIPREDEFFECT
For type='omx' only.n.latent*n.TIpred effect matrix of time independent
predictors on latents at T0. "auto" freely estimates all parameters, though note that under the default
setting of stationary for ctFit, this matrix is ignored as the effects are determined based on
the overall process parameters.
TIPREDVAR
For type='omx' only.lower triangular n.TIpred * n.TIpred Cholesky decomposed covariance
matrix for all time independent predictors.
"auto" (default) freely estimates all parameters.
PARS
for types 'stanct' and 'standt' only. May be of any structure, only needed to contain extra parameters for certain non-linear models.
startValues
For type='omx' only. A named vector, where the names of each value must match a parameter in the specified model,
and the value sets the starting value for that parameter during optimization.
If not set, random starting values representing relatively stable processes with small effects and
covariances are generated by ctFit.
Better starting values may improve model fit speed and the chance of an appropriate model fit.
Examples
### Frequentist example:
### impulse and level change time dependent predictor
### example from Driver, Oud, Voelkle (2015)
data('ctExample2')
tdpredmodel <- ctModel(n.manifest = 2, n.latent = 3, n.TDpred = 1,
Tpoints = 8, manifestNames = c('LeisureTime', 'Happiness'),
TDpredNames = 'MoneyInt',
latentNames = c('LeisureTime', 'Happiness', 'MoneyIntLatent'),
LAMBDA = matrix(c(1,0, 0,1, 0,0), ncol = 3), TRAITVAR = "auto")
tdpredmodel$TRAITVAR[3, ] <- 0
tdpredmodel$TRAITVAR[, 3] <- 0
tdpredmodel$DIFFUSION[, 3] <- 0
tdpredmodel$DIFFUSION[3, ] <- 0
tdpredmodel$T0VAR[3, ] <- 0
tdpredmodel$T0VAR[, 3] <- 0
tdpredmodel$CINT[3] <- 0
tdpredmodel$T0MEANS[3] <- 0
tdpredmodel$TDPREDEFFECT[3, ] <- 1
tdpredmodel$DRIFT[3, ] <- 0
###Bayesian example:
model<-ctModel(type='stanct',
n.latent=2, latentNames=c('eta1','eta2'),
n.manifest=2, manifestNames=c('Y1','Y2'),
n.TDpred=1, TDpredNames='TD1',
n.TIpred=3, TIpredNames=c('TI1','TI2','TI3'),
LAMBDA=diag(2))
ctsem documentation built on Sept. 11, 2024, 9:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| ctModel | R Documentation |
Define a ctsem model
Description
This function is used to specify a continuous time structural equation model,
which can then be fit to data with function ctStanFit.
Usage
ctModel(
LAMBDA,
type = "omx",
n.manifest = "auto",
n.latent = "auto",
Tpoints = NULL,
manifestNames = "auto",
latentNames = "auto",
id = "id",
time = "time",
silent = FALSE,
T0VAR = "auto",
T0MEANS = "auto",
MANIFESTMEANS = "auto",
MANIFESTVAR = "auto",
DRIFT = "auto",
CINT = "auto",
DIFFUSION = "auto",
n.TDpred = "auto",
TDpredNames = "auto",
n.TIpred = "auto",
TIpredNames = "auto",
tipredDefault = TRUE,
TRAITVAR = NULL,
T0TRAITEFFECT = NULL,
MANIFESTTRAITVAR = NULL,
TDPREDMEANS = "auto",
TDPREDEFFECT = "auto",
T0TDPREDCOV = "auto",
TDPREDVAR = "auto",
TRAITTDPREDCOV = "auto",
TDTIPREDCOV = "auto",
TIPREDMEANS = "auto",
TIPREDEFFECT = "auto",
T0TIPREDEFFECT = "auto",
TIPREDVAR = "auto",
PARS = NULL,
startValues = NULL
)
Arguments
LAMBDA |
n.manifest*n.latent loading matrix relating latent to manifest variables, with latent processes 1:n.latent along the columns, and manifest variables 1:n.manifest in the rows. |
type |
character string. If 'omx' (default) configures model for maximum likelihood fitting with ctFit, using OpenMx.
If 'stanct' or 'standt' configures either continuous ('stanct') or discrete ('standt') time
model for Bayesian fitting with |
n.manifest |
Number of manifest indicators per individual at each measurement occasion / time point. Manifest variables are included as the first element of the wide data matrix, with all the 1:n.manifest manifest variables at time 1 followed by those of time 2, and so on. |
n.latent |
Number of latent processes. |
Tpoints |
For type='omx' only. Number of time points, or measurement occasions, in the data. This will generally be the maximum
number of time points for a single individual, but may be one extra if sample relative time intervals are used,
see |
manifestNames |
n.manifest length vector of manifest variable names as they appear in the data structure, without any _Tx time point suffix that may be present in wide data. Defaults to Y1, Y2, etc. |
latentNames |
n.latent length vector of latent variable names (used for naming parameters, defaults to eta1, eta2, etc). |
id |
character string denoting column name containing subject identification variables. id data may be of any form, though will be coerced internally to an integer sequence rising from 1. |
time |
character string denoting column name containing timing data. Timing data must be numeric. |
silent |
Suppress all output to console. |
T0VAR |
lower triangular n.latent*n.latent cholesky matrix of latent process initial variance / covariance. "auto" freely estimates all parameters. |
T0MEANS |
n.latent*1 matrix of latent process means at first time point, T0. "auto" freely estimates all parameters. |
MANIFESTMEANS |
n.manifest*1 matrix of manifest intercept parameters. "auto" frees all parameters. |
MANIFESTVAR |
lower triangular n.manifest*n.manifest cholesky matrix of variance / covariance between manifests at each measurement occasion (i.e. measurement error / residual). "auto" freely estimates variance parameters, and fixes covariances between manifests to 0. "free" frees all values, including covariances. |
DRIFT |
n.latent*n.latent DRIFT matrix of continuous auto and cross effects, relating the processes over time. "auto" freely estimates all parameters. |
CINT |
n.latent * 1 matrix of latent process intercepts, allowing for non 0 asymptotic levels of the latent processes. Generally only necessary for additional trends and more complex dynamics. "auto" fixes all parameters to 0. |
DIFFUSION |
lower triangular n.latent*n.latent cholesky matrix of diffusion process variance and covariance (latent error / dynamic innovation). "auto" freely estimates all parameters. |
n.TDpred |
Number of time dependent predictor variables in the dataset. |
TDpredNames |
n.TDpred length vector of time dependent predictor variable names, as they appear in the data structure, without any _Tx time point suffix that may appear in wide data. Default names are TD1, TD2, etc. |
n.TIpred |
Number of time independent predictors. Each TIpredictor is inserted at the right of the data matrix, after the time intervals. |
TIpredNames |
n.TIpred length vector of time independent predictor variable names, as they appear in the data structure. Default names are TI1, TI2, etc. |
tipredDefault |
Logical. TRUE sets any parameters with unspecified time independent predictor effects to have effects estimated, FALSE fixes the effect to zero unless individually specified. |
TRAITVAR |
For type='omx' only. Either NULL, if no trait / unobserved heterogeneity effect, or lower triangular n.latent*n.latent cholesky matrix of trait variance / covariance across subjects. "auto" freely estimates all parameters. |
T0TRAITEFFECT |
For type='omx' only. Either NULL, if no trait / individual heterogeneity effect, or lower triangular n.latent*n.latent cholesky matrix of initial trait variance / covariance. "auto" freely estimates all parametrers, if the TRAITVAR matrix is specified. |
MANIFESTTRAITVAR |
For type='omx' only. Either NULL (default) if no trait variance / individual heterogeneity in the level of
the manifest indicators, otherwise a lower triangular n.manifest * n.manifest variance / covariance matrix.
Set to "auto" to include and free all parameters - but identification problems will arise if |
TDPREDMEANS |
For type='omx' only. (n.TDpred * (Tpoints - 1)) rows * 1 column matrix of time dependent predictor means. If 'auto', the means are freely estimated. Otherwise, the means for the Tpoints observations of your first time dependent predictor are followed by those of TDpred 2, and so on. |
TDPREDEFFECT |
n.latent*n.TDpred matrix of effects from time dependent predictors to latent processes. Effects from 1:n.TDpred columns TDpredictors go to 1:n.latent rows of latent processes. "auto" freely estimates all parameters. |
T0TDPREDCOV |
For type='omx' only. n.latent rows * (Tpoints * n.TDpred) columns covariance matrix between latents at T0 and time dependent predictors. Default of "auto" restricts covariance to 0, which is consistent with covariance to other time points. To freely estimate parameters, specify either 'free', or the desired matrix. |
TDPREDVAR |
For type='omx' only. lower triangular (n.TDpred * Tpoints) rows * (n.TDpred * Tpoints) columns variance / covariance cholesky matrix for time dependent predictors. "auto" (default) freely estimates all parameters. |
TRAITTDPREDCOV |
For type='omx' only. n.latent rows * (n.TDpred*Tpoints) columns covariance matrix of latent traits and time dependent predictors. Defaults to zeroes, assuming predictors are independent of subjects baseline levels. When predictors depend on the subjects, this should instead be set to 'free' or manually specified. The Tpoints columns of the first preditor are followed by those of the second and so on. Covariances with the trait variance of latent process 1 are specified in row 1, process 2 in row 2, etc. "auto" (default) sets this matrix to zeroes, (if both traits and time dependent predictors exist, otherwise this matrix is set to NULL, and ignored in any case). |
TDTIPREDCOV |
For type='omx' only. (n.TDpred * Tpoints) rows * n.TIpred columns covariance matrix between time dependent and time independent predictors. "auto" (default) freely estimates all parameters. |
TIPREDMEANS |
For type='omx' only. n.TIpred * 1 matrix of time independent predictor means. If 'auto', the means are freely estimated. |
TIPREDEFFECT |
For type='omx' only. n.latent*n.TIpred effect matrix of time independent predictors on latent processes. "auto" freely estimates all parameters and generates starting values. TIPREDEFFECT parameters for type='stan' are estimated by default on all subject level parameters, to restrict this, manually edit the model object after creation. |
T0TIPREDEFFECT |
For type='omx' only.n.latent*n.TIpred effect matrix of time independent
predictors on latents at T0. "auto" freely estimates all parameters, though note that under the default
setting of |
TIPREDVAR |
For type='omx' only.lower triangular n.TIpred * n.TIpred Cholesky decomposed covariance matrix for all time independent predictors. "auto" (default) freely estimates all parameters. |
PARS |
for types 'stanct' and 'standt' only. May be of any structure, only needed to contain extra parameters for certain non-linear models. |
startValues |
For type='omx' only. A named vector, where the names of each value must match a parameter in the specified model, and the value sets the starting value for that parameter during optimization. If not set, random starting values representing relatively stable processes with small effects and covariances are generated by ctFit. Better starting values may improve model fit speed and the chance of an appropriate model fit. |
Examples
### Frequentist example:
### impulse and level change time dependent predictor
### example from Driver, Oud, Voelkle (2015)
data('ctExample2')
tdpredmodel <- ctModel(n.manifest = 2, n.latent = 3, n.TDpred = 1,
Tpoints = 8, manifestNames = c('LeisureTime', 'Happiness'),
TDpredNames = 'MoneyInt',
latentNames = c('LeisureTime', 'Happiness', 'MoneyIntLatent'),
LAMBDA = matrix(c(1,0, 0,1, 0,0), ncol = 3), TRAITVAR = "auto")
tdpredmodel$TRAITVAR[3, ] <- 0
tdpredmodel$TRAITVAR[, 3] <- 0
tdpredmodel$DIFFUSION[, 3] <- 0
tdpredmodel$DIFFUSION[3, ] <- 0
tdpredmodel$T0VAR[3, ] <- 0
tdpredmodel$T0VAR[, 3] <- 0
tdpredmodel$CINT[3] <- 0
tdpredmodel$T0MEANS[3] <- 0
tdpredmodel$TDPREDEFFECT[3, ] <- 1
tdpredmodel$DRIFT[3, ] <- 0
###Bayesian example:
model<-ctModel(type='stanct',
n.latent=2, latentNames=c('eta1','eta2'),
n.manifest=2, manifestNames=c('Y1','Y2'),
n.TDpred=1, TDpredNames='TD1',
n.TIpred=3, TIpredNames=c('TI1','TI2','TI3'),
LAMBDA=diag(2))
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.