Skip to contents

A list of the constructor functions building the forest specifications that the monotone, interactions, blocks, variance and forests arguments of dbarts, dbartsSpec and bart accept. The constructors are not exported, so that names like forest and blocks stay out of the search path, where another package could mask them or be masked depending on attach order.

Inside those arguments, and inside a formula's forest() term, the constructors resolve by bare name: a call is always the constructor, and a bare name the caller has assigned a value to is that value. Anywhere else - a specification built ahead of the call, or an argument a wrapper forces before passing it on - write dbartsForests$interactions(...). forest()'s first argument, the predictors a forest splits on, is read as terms when it names a predictor of the fit and otherwise takes the value it has where and when the constructor is called. Its basis is read the same way: a name of a column of the fit's data is that column, and anything else is what it was where and when the constructor is called; see forest.

Format

A list of functions:

interactions

Interaction constraints; see interactions.

blocks

Block-additive constraints; see blocks.

monotone

Monotone constraints and their prior; see monotone.

forest

One forest of a model, in a forests list or as a term of a formula; see forest.

varianceForest

The heteroscedastic variance forest; see varianceForest.

Examples

## built ahead of the call, then passed as a value
constraint <- dbartsForests$interactions(max.order = 1)

set.seed(0)
n <- 100L
x <- matrix(runif(n * 3), n, 3, dimnames = list(NULL, c("x1", "x2", "x3")))
y <- 2 * x[, 1] + ifelse(x[, 2] > 0.5, 1, -1) + rnorm(n, 0, 0.2)

fit <- bart(x, y,
             interactions = constraint,
             n.trees = 25L, n.samples = 20L, n.burn = 20L,
             n.chains = 1L, verbose = FALSE)

## the same constraint, written by bare name inside the argument
fit.bare <- bart(x, y,
                  interactions = interactions(max.order = 1),
                  n.trees = 25L, n.samples = 20L, n.burn = 20L,
                  n.chains = 1L, verbose = FALSE)