buildRIVPACS: Build a RIVPACS model

View source: R/build.R

buildRIVPACSR Documentation

Build a RIVPACS model

Description

This function builds a RIVPACS model using either linear discriminant analysis, random forests, or a multinomial log linear model. The get* functions can be used to extract model components.

Usage

buildRIVPACS(formula, data, type = c("lda", "multinom", "rf"), ...)

## S3 method for class 'rivpacs'
getSamples(x, ...)

## S3 method for class 'rivpacs'
getSites(x, ...)

getCalibrationData(x, ...)

getGroupMeans(x, ...)

getGroupInvCov(x, ...)

getCalibrationGroups(x, ...)

getCalibrationVars(x, ...)

getFormula(x, ...)

getModel(x, ...)

## S3 method for class 'rivpacs'
getCalibrationData(mod)

## S3 method for class 'rivpacs'
getGroupMeans(mod)

## S3 method for class 'rivpacs'
getGroupInvCov(mod)

## S3 method for class 'rivpacs'
getCalibrationGroups(mod)

## S3 method for class 'rivpacs'
getCalibrationVars(mod)

## S3 method for class 'rivpacs'
getFormula(mod)

## S3 method for class 'rivpacs'
getModel(mod)

Arguments

formula

a formula with the groups on the left and the predictors on the right

data

the data frame of site/sample data

type

the type of model to build

...

additional arguments to be passed to the modeling functions

Value

a RIVPACS model object (a function)


jasonelaw/RIVPACS documentation built on Sept. 27, 2022, 6:34 p.m.