spaMM (version 3.2.0)

how: Extract information about how an object was obtained

Description

how is defined as a generic with currently only one non-default method, for objects of class HLfit. This method provide information about how such a fit was obtained.

Usage

how(object, ...)
# S3 method for HLfit
how(object, devel=FALSE, verbose=TRUE, format=print, ...)

Arguments

object

Any R object.

devel

Boolean; Whether to provide additional cryptic information. For development purposes, not further documented.

verbose

Boolean; Whether to print information about the input object.

format

wrapper for printing format. E.g., cat(crayon::yellow(s));cat("\n") could be used instead of the default.

…

Other arguments that may be needed by some method.

Value

A list, returned invisibly, whose elements are not further described here. If verbose is TRUE, the function prints a message presenting these elements, some of which may be slightly cryptic (it is a clean way of getting the fit time, though). This function is work in progress.

Examples

# NOT RUN {
foo <- HLfit(y~x, data=data.frame(x=runif(3),y=runif(3)),HLmethod="ML",ranFix=list(phi=1))
how(foo)
# }