latrend (version 1.3.0)

converged: Check model convergence

Description

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

Usage

# S4 method for 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 model-specific methods: clusterTrajectories(), coef.lcModel(), deviance.lcModel(), df.residual.lcModel(), fitted.lcModel(), fittedTrajectories(), lcModel-class, logLik.lcModel(), model.frame.lcModel(), nobs.lcModel(), postprob(), predict.lcModel(), predictAssignments(), predictForCluster(), predictPostprob(), residuals.lcModel(), sigma.lcModel(), time.lcModel()

Examples

# NOT RUN {
data(latrendData)
method <- lcMethodLMKM(Y ~ Time, id = "Id", time = "Time")
model <- latrend(method, latrendData, nClusters = 2)
converged(model)
# }