Skip to contents

Minimalist visualization of the branching and leaf contents of one tree in a fitted bartBT/bart model, or in a dbartsSampler. A fit-level convenience wrapper around the sampler's plotTree method, so the trees can be plotted without reaching into the sampler stored on the fit.

bart's four own-class fits ("bartMultinomial", "bartOrdinal", "bartNegbin", "bartHurdle") refuse by name instead: their trees live on the sampler(s) those fits carry (object$fit for the first three, object$zero$fit/ object$positive$fit for the hurdle), which plotTree can be called on directly.

Usage

plotTree(object, ...)

# S3 method for class 'bart'
plotTree(
    object, treeNum = 1L, chainNum, sampleNum, forest = NULL, ...)

# S3 method for class 'dbartsSampler'
plotTree(object, ...)

# S3 method for class 'bartMultinomial'
plotTree(object, ...)

# S3 method for class 'bartOrdinal'
plotTree(object, ...)

# S3 method for class 'bartNegbin'
plotTree(object, ...)

# S3 method for class 'bartHurdle'
plotTree(object, ...)

Arguments

object

A fitted model of class bart (from bartBT or bart), or a dbartsSampler. Fits must have been made with the trees kept (keeptrees/keepTrees equal to TRUE).

treeNum

An integer, the index of the tree to plot.

chainNum

An integer, the index of the chain to plot from. For a bart fit with a single chain it may be omitted.

sampleNum

An integer, the index of the saved sample to plot from. When omitted, the last sample is used (or the current working trees when the trees were not kept as samples).

forest

A number, the forest to plot from (1-indexed, as dbartsSampler's getTrees accepts), or a string, its label (see forest). For a sampler with a single forest it may be omitted; a sampler with more than one (a Bayesian causal forest, or a multinomial fit's own sampler) requires it.

...

Additional arguments, including treePlotPars (a named numeric vector controlling nodeHeight, nodeWidth, and nodeGap) and further arguments passed on to plot. sample/chain are refused by name, on every method including dbartsSampler's: they partial-match this method's own sampleNum/chainNum and would otherwise draw a different tree than intended.

Value

Invisibly returns NULL; called for the side effect of drawing.

Details

The rendering handles constant, linear, and Gaussian-process leaves. For a multiple-chain fit, chainNum selects the chain. Equivalent to calling the plotTree method on the underlying sampler, i.e. object$fit$plotTree(...) for a bart fit.

See also

Examples

f <- function(x)
    10 * sin(pi * x[,1] * x[,2]) + 20 * (x[,3] - 0.5)^2 +
        10 * x[,4] + 5 * x[,5]

set.seed(99)
sigma <- 1.0
n     <- 100

x  <- matrix(runif(n * 10), n, 10)
Ey <- f(x)
y  <- rnorm(n, Ey, sigma)

fit <- bart(x, y, n.samples = 40L, n.burn = 10L, n.trees = 25L,
             n.chains = 1L, keepTrees = TRUE, verbose = FALSE)

plotTree(fit, treeNum = 1L, sampleNum = 40L)