predict.ordinalNet {ordinalNet}R Documentation

Predict method for an "ordinalNet" object

Description

Obtains predicted probabilities, predicted class, or linear predictors.

Usage

## S3 method for class 'ordinalNet'
predict(
  object,
  newx = NULL,
  whichLambda = NULL,
  criteria = c("aic", "bic"),
  type = c("response", "class", "link"),
  ...
)

Arguments

object

An "ordinalNet" S3 object.

newx

Optional covariate matrix. If NULL, fitted values will be obtained for the training data, as long as the model was fit with the argument keepTrainingData=TRUE.

whichLambda

Optional index number of the desired lambda value within the solution path sequence.

criteria

Selects the best lambda value by AIC or BIC. Only used if whichLambda=NULL.

type

The type of prediction required. Type "response" returns a matrix of fitted probabilities. Type "class" returns a vector containing the class number with the highest fitted probability. Type "link" returns a matrix of linear predictors.

...

Not used. Additional predict arguments.

Value

The object returned depends on type.

See Also

ordinalNet

Examples

# See ordinalNet() documentation for examples.
[Package ordinalNet version 2.12 Index]