summary.orf: Summary of the Ordered Forest

Description Usage Arguments Details Author(s) Examples

View source: R/orf_user.R

Description

summary of an estimated Ordered Forest object of class orf

Usage

1
2
## S3 method for class 'orf'
summary(object, latex = FALSE, ...)

Arguments

object

estimated Ordered Forest object of class orf

latex

logical, if TRUE latex coded summary will be generated (default is FALSE)

...

further arguments (currently ignored)

Details

summary.orf provides a short summary of the Ordered Forest estimation, including the input information regarding the values of hyperparameters as well as the output information regarding the prediction accuracy.

Author(s)

Gabriel Okasa

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# Ordered Forest
require(orf)

# load example data
data(odata)

# specify response and covariates
Y <- as.numeric(odata[, 1])
X <- as.matrix(odata[, -1])

# estimate Ordered Forest
orf_fit <- orf(X, Y)

# show summary of the orf estimation
summary(orf_fit)

# show summary of the orf estimation coded in LaTeX
summary(orf_fit, latex = TRUE)

orf documentation built on March 26, 2020, 7:30 p.m.