buildModel: Builds a model of the specified type

In henkelstone/NPEL.Classification: Classifaction and data-handling routines for NPEL Caribou Project

Description

This method builds a model of the requested type. It is passed data, a formula object, and whatever arguments that model type would ordinarily use (see details).

Usage

buildModel(type, data, fx, args = NULL)

Arguments

type	the type of model to build
data	a data frame specifying data
fx	a model formula object
args	(optional) other arguments to pass to the model.

Details

Model building is such a primary part of this package, but each modelling package does not use the same set of calls or parameters to build models. This function is a wrapper that builds models of using a standard interface. It converts from the normal suite of parameters: a data frame, a formula object accessing variables within the data frame, and various arguments specifying the particulars required by that model package. See generateModels for more information on arguments that can/should be passed.

It also wraps results from packages that do not return an S3 class in a class object by attaching a class attribute. For for modelling packages that return objects, this package uses the same class names for interoperability, however, in some cases it attaches data that are not included by that class, but are required by NPEL.Classification.

Value

a model object of the type requested, with the class set to match the constants used in this package

See Also

generateModels

henkelstone/NPEL.Classification documentation built on May 17, 2019, 3:42 p.m.