latrend (version 1.3.0)

estimationTime: Get the model estimation time

Description

Get the estimation time of the model, determined by the time taken for the associated fit() function to finish.

Usage

# S4 method for lcModel
estimationTime(object, unit = "secs", ...)
# S4 method for lcModels
estimationTime(object, unit = "secs", ...)
# S4 method for list
estimationTime(object, unit = "secs", ...)

Arguments

object

The list of lcModel objects.

unit

The time unit in which the estimation time should be outputted. By default, estimation time is in seconds. For accepted units, see base::difftime.

...

Additional arguments.

Value

A numeric representing the model estimation time, in the specified unit.

Examples

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

estimationTime(model)
estimationTime(model, unit = 'mins')
estimationTime(model, unit = 'days')
# }