Summary Method for ocf Objects

Source: R/generic-s3.R

Summarizes an ocf object.

# S3 method for class 'ocf'
summary(object, ...)

Arguments

object

An ocf object.

...

Further arguments passed to or from other methods.

Value

Summarizes an ocf object.

References

  • Di Francesco, R. (2023). Ordered Correlation Forest. arXiv preprint arXiv:2309.08755.

See also

ocf, marginal_effects

Author

Riccardo Di Francesco

Examples

## Generate synthetic data.
set.seed(1986)

data <- generate_ordered_data(100)
sample <- data$sample
Y <- sample$Y
X <- sample[, -1]

## Fit ocf.
forests <- ocf(Y, X)

## Summary.
summary(forests)
#> Call: 
#> ocf(Y, X) 
#> 
#> Data info: 
#> Full sample size:   100 
#> N. covariates:      6 
#> Classes:            1 2 3 
#> 
#> Relative variable importance: 
#>    x1    x2    x3    x4    x5    x6 
#> 0.345 0.045 0.278 0.071 0.224 0.037 
#> 
#> Tuning parameters: 
#> N. trees:           2000 
#> mtry:               3 
#> min.node.size       5 
#> Subsampling scheme: No replacement 
#> Honesty:            FALSE 
#> Honest fraction:    0