flam (version 3.2)

summary.flamCV: Summarizes a Call to flamCV

Description

This function summarizes a call to codeflamCV and identifies the tuning parameter chosen by cross-validation.

Usage

# S3 method for flamCV
summary(object, …)

Arguments

object

an object of class "flamCV".

…

additional arguments to be passed. These are ignored in this function.

References

Petersen, A., Witten, D., and Simon, N. (2014). Fused Lasso Additive Model. arXiv preprint arXiv:1409.5391.

See Also

flamCV

Examples

# NOT RUN {
#See ?'flam-package' for a full example of how to use this package

#generate data
set.seed(1)
data <- sim.data(n = 50, scenario = 1, zerof = 0, noise = 1)
#fit model and select tuning parameters using 2-fold cross-validation
#note: use larger 'n.fold' (e.g., 10) in practice
flamCV.out <- flamCV(x = data$x, y = data$y, n.fold = 2)

#we can summarize the cross-validation function call
summary(flamCV.out)
#lambda chosen by cross-validation is also available from
flamCV.out$lambda.cv
# }