formula_setup: Internal Function

Description Usage Arguments

View source: R/internal.R

Description

Undocumented function. Do not use directly

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
formula_setup(
  formula = NULL,
  response.name = NULL,
  linear.name = NULL,
  smooth.name = NULL,
  family = NULL,
  smooth.penalty = NULL,
  num.knots = NULL,
  offset.name = NULL,
  interactions = F
)

Arguments

formula

A formula to be parsed

response.name

The name of the response variable. Vector of two if family = "binomial"

linear.name

The names of the variables to be used as linear predictors

smooth.name

The names of the variables to be used as smoothers

family

The family describing the error distribution and link function to be used in the model. A character string which can only be "gaussian" (default), "binomial", "poisson" or "cox". For family = "binomial", response can be a vector of two and for family="cox", weights must be provided (see details below).

smooth.penalty

The penalty used on the smoothers. Can be 1 or 2

num.knots

Number of knots for each smoothers. Can be a single integer (recycled for each smoother variable) or a vector of integers the same length as the number of smoothers.

offset.name

The name of the offset variable. NULL (default) if not provided

interactions

logical. Should interactions be included.


plsmselect documentation built on Dec. 1, 2019, 1:11 a.m.