| converged {latrend} | R Documentation |
Check model convergence
Description
Check whether the fitted object converged.
Usage
converged(object, ...)
## S4 method for signature 'lcModel'
converged(object, ...)
Arguments
object |
The model. |
... |
Not used. |
Value
Either logical indicating convergence, or a numeric status code.
The default lcModel implementation returns NA.
Implementation
Classes extending lcModel can override this method to return a convergence status or code.
setMethod("converged", "lcModelExt", function(object, ...) {
# return convergence code
})
See Also
Other lcModel functions:
clusterNames(),
clusterProportions(),
clusterSizes(),
clusterTrajectories(),
coef.lcModel(),
deviance.lcModel(),
df.residual.lcModel(),
estimationTime(),
externalMetric(),
fitted.lcModel(),
fittedTrajectories(),
getCall.lcModel(),
getLcMethod(),
ids(),
lcModel-class,
metric(),
model.frame.lcModel(),
nClusters(),
nIds(),
nobs.lcModel(),
plot-lcModel-method,
plotClusterTrajectories(),
plotFittedTrajectories(),
postprob(),
predict.lcModel(),
predictAssignments(),
predictForCluster(),
predictPostprob(),
qqPlot(),
residuals.lcModel(),
sigma.lcModel(),
strip(),
time.lcModel(),
trajectoryAssignments()
Examples
data(latrendData)
method <- lcMethodLMKM(Y ~ Time, id = "Id", time = "Time")
model <- latrend(method, latrendData, nClusters = 2)
converged(model)