converged: Check model convergence

In latrend: A Framework for Clustering Longitudinal Data

Check model convergence

Description

Check convergence of the fitted lcModel object. The default implementation returns NA.

Usage

## S4 method for signature 'lcModel'
converged(object, ...)

Arguments

object	The lcModel to check for convergence.
...	Additional arguments.

Value

Either logical indicating convergence, or a numeric status code.

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,lcModel,lcModel-method, 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)

latrend documentation built on March 31, 2023, 5:45 p.m.