loadModels: Load Built-in GAM formulas

View source: R/loadModels.R

loadModelsR Documentation

Load Built-in GAM formulas

Description

Returns built-in GAM formulas

Usage

loadModels(gamSelect = "gam4")

Arguments

gamSelect

character vector of models (Current options include gam0, gam1, gam2, gam3, gam4, gam5)

Details

By default, the function analysisOrganizeData will store the formulas for gam0-gam4 in the variable analySpec$gamModels as a list. The user can customize this list with the function loadModels (see example).

Value

Returns a list with GAM formulas

Examples

# run analysisOrganizeData function to create the list analySpec
dfr <- analysisOrganizeData (dataCensored, report=NA)
df        <- dfr[["df"]]
analySpec <- dfr[["analySpec"]]

# current models in analySpec
analySpec$gamModels

# set models in analySpec to gam0, gam1, and gam2 only
analySpec$gamModels <- loadModels(c('gam0','gam1','gam2'))


leppott/baytrends documentation built on Nov. 2, 2024, 6:42 p.m.