Package index

Supervised learning

High-level functionality for training supervised Bayesian tree ensembles (BART, XBART)

bart()

Run BART for Supervised Learning

predict(<bartmodel>)

Predict from a BART Model

print(<bartmodel>)

Print Summary of BART Model

summary(<bartmodel>)

Summarize BART Model Fit and Parameters

plot(<bartmodel>)

Plot BART Model Fit

extractParameter(<bartmodel>)

Extract BART Parameter Samples

getRandomEffectSamples(<bartmodel>)

Extract Random Effects Samples from BART Model

computeBARTPosteriorInterval()

Compute BART Posterior Credible Intervals

computeContrastBARTModel()

Compute Contrast for BART Model

sampleBARTPosteriorPredictive()

Sample BART Posterior Predictive

saveBARTModelToJson() saveBARTModelToJsonFile() saveBARTModelToJsonString() createBARTModelFromJson() createBARTModelFromJsonFile() createBARTModelFromJsonString() createBARTModelFromCombinedJson() createBARTModelFromCombinedJsonString()

BART Serialization Routines

Causal inference

High-level functionality for estimating causal effects using Bayesian tree ensembles (BCF, XBCF)

bcf()

Run BCF for Causal Effect Estimation

predict(<bcfmodel>)

Predict from BCF Model

print(<bcfmodel>)

Print Summary of BCF Model

summary(<bcfmodel>)

Summarize BCF Model

plot(<bcfmodel>)

Plot BCF Model

extractParameter(<bcfmodel>)

Extract BCF Parameter Samples

getRandomEffectSamples(<bcfmodel>)

Extract Random Effect Samples from BCF Model

computeBCFPosteriorInterval()

Compute BCF Posterior Credible Intervals

computeContrastBCFModel()

Compute Contrast for BCF Model

sampleBCFPosteriorPredictive()

Sample BCF Posterior Predictive

saveBCFModelToJson() saveBCFModelToJsonFile() saveBCFModelToJsonString() createBCFModelFromJson() createBCFModelFromJsonFile() createBCFModelFromJsonString() createBCFModelFromCombinedJson() createBCFModelFromCombinedJsonString()

BCF Serialization Routines

Low-level functionality

Serialization

Classes and functions for converting sampling artifacts to JSON and saving to disk

CppJson

JSON C++ Object Wrapper

createCppJson() createCppJsonFile() createCppJsonString()

JSON Creation Routines

loadForestContainerJson() loadForestContainerCombinedJson() loadForestContainerCombinedJsonString()

Forest Container Serialization Routines

loadVectorJson()

Load Vector from JSON

loadScalarJson()

Load Scalar from JSON

loadRandomEffectSamplesJson() loadRandomEffectSamplesCombinedJson() loadRandomEffectSamplesCombinedJsonString()

Random Effects Container Serialization Routines

Data

Classes and functions for preparing data for sampling algorithms

ForestDataset

Forest Dataset C++ Wrapper

createForestDataset()

Create ForestDataset Object

Outcome

Outcome Data C++ Wrapper

createOutcome()

Create Outcome Object

RandomEffectsDataset

Random Effects Dataset C++ Wrapper

createRandomEffectsDataset()

Create RandomEffectsDataset Object

preprocessTrainData() preprocessPredictionData() savePreprocessorToJson() savePreprocessorToJsonString() createPreprocessorFromJson() createPreprocessorFromJsonString()

Data Preprocessing Routines

Forest

Classes and functions for constructing and persisting forests

Forest

Forest C++ Wrapper

createForest()

Create Forest Object

ForestModel

Forest Model C++ Wrapper

createForestModel()

Create ForestModel Object

ForestSamples

Forest Container C++ Wrapper

createForestSamples()

Create ForestSamples Object

print(<ForestSamples>)

Summarize a ForestSamples Object

ForestModelConfig

Forest Model Configuration Object

createForestModelConfig()

Create ForestModelConfig Object

GlobalModelConfig

Global Model Configuration Object

createGlobalModelConfig()

Create GlobalModelConfig Object

CppRNG

Random Number Generator C++ Wrapper

createCppRNG()

Create CppRNG Object

calibrateInverseGammaErrorVariance()

Calibrate Inverse Gamma Prior

computeForestLeafIndices() computeForestLeafVariances() computeForestMaxLeafIndex()

Forest Kernel Computation Routines

resetActiveForest() resetForestModel()

Forest State Management Routines

Random Effects

Classes and functions for constructing and persisting random effects terms

RandomEffectSamples

Random Effect Container C++ Wrapper

createRandomEffectSamples()

Create RandomEffectSamples Object

print(<RandomEffectSamples>)

Summarize a RandomEffectSamples Object

RandomEffectsModel

Random Effects Model C++ Wrapper

createRandomEffectsModel()

Create RandomEffectsModel Object

RandomEffectsTracker

Random Effects Tracker C++ Wrapper

createRandomEffectsTracker()

Create RandomEffectsTracker Object

getRandomEffectSamples()

Extract Random Effect Samples Generic Function

sampleGlobalErrorVarianceOneIteration()

Sample Global Error Variance

sampleLeafVarianceOneIteration()

Sample Leaf Scale

resetRandomEffectsModel() resetRandomEffectsTracker() rootResetRandomEffectsModel() rootResetRandomEffectsTracker()

Random Effects State Management Routines

Utilities

Miscellaneous “utility” classes and functions

OutcomeModel()

Create a New Outcome Model Object

sample_without_replacement()

Sample Without Replacement

extractParameter()

Extract Parameter Samples Generic Function

Package info

High-level package details

stochtree stochtree-package

stochtree: Stochastic Tree Ensembles (XBART and BART) for Supervised Learning and Causal Inference