tree_info {ocf} | R Documentation |
Tree Information in Readable Format
Description
Extracts tree information from a ocf.forest
object.
Usage
tree_info(object, tree = 1)
Arguments
object |
|
tree |
Number of the tree of interest. |
Details
Nodes and variables IDs are 0-indexed, i.e., node 0 is the root node.
All values smaller than or equal to splitval
go to the left and all values larger go to the right.
Value
A data.frame
with the following columns:
nodeID |
Node IDs. |
leftChild |
IDs of the left child node. |
rightChild |
IDs of the right child node. |
splitvarID |
IDs of the splitting variable. |
splitvarName |
Name of the splitting variable. |
splitval |
Splitting value. |
terminal |
Logical, TRUE for terminal nodes. |
prediction |
One column with the predicted conditional class probabilities. |
Author(s)
Riccardo Di Francesco
References
Di Francesco, R. (2025). Ordered Correlation Forest. Econometric Reviews, 1–17. doi:10.1080/07474938.2024.2429596.
See Also
Examples
## Generate synthetic data.
set.seed(1986)
data <- generate_ordered_data(1000)
sample <- data$sample
Y <- sample$Y
X <- sample[, -1]
## Fit ocf.
forests <- ocf(Y, X)
## Extract information from tenth tree of first forest.
info <- tree_info(forests$forests.info$forest.1, tree = 10)
head(info)
[Package ocf version 1.0.3 Index]