summary.margins.orf: Summary of the Ordered Forest Marginal Effects

View source: R/margins.R

summary.margins.orfR Documentation

Summary of the Ordered Forest Marginal Effects

Description

summary of estimated marginal effects of the Ordered Forest of class margins.orf

Usage

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

Arguments

object

estimated Ordered Forest Marginal Effect object of type margins.orf

latex

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

...

further arguments (currently ignored)

Details

summary.margins.orf provides estimation results of the Ordered Forest marginal effects. The summary contains the results for the marginal effects for each covariate and each outcome class, optionally with inference as well. Furthermore, summary output as a LaTeX table is supported in order to directly extract the results for the documentation.

Author(s)

Gabriel Okasa

Examples

## 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)

# estimate marginal effects of the orf
orf_margins <- margins(orf_fit)

# summary of marginal effects
summary(orf_margins)

# summary of marginal effects coded in LaTeX
summary(orf_margins, latex = TRUE)



orf documentation built on July 24, 2022, 1:05 a.m.