linear: Returns a linear object

In craiggrabowski/predictr: Objects For Fast Predictions Of Common Model Types

Description

linear returns an linear object.

Usage

linear(x, data = 0)

Arguments

x	Name of object
data	vector (defaults to 0)

Details

A linear object corresponds with the most common type of summand in a linear-based model, namely one equal to a parameter a times the value of a covariate x. The summand has the following form:

a * x

In the case of a univariate model, a is a scalar. For multivariate models, a is a vector.

Specifying the linear object requires two data elements. The first element, x, is the name of the field associated with the covariate. This name indicates how to identify the covariate in a table of data. The second element, data, is the parameter, which can be a scalar or a vector.

craiggrabowski/predictr documentation built on May 28, 2019, 7:48 p.m.