Skip to contents

Core workflows

fit_observational_forest()
Fit an observational causal forest workflow
fit_survival_forest()
Fit a survival causal forest workflow
fit_instrumental_forest()
Fit an instrumental forest workflow
case_study_catalog()
Case-study catalog for heteff
available_case_studies()
List built-in case study names
run_case_study()
Run a built-in case study
export_tables()
Export output tables to CSV files
export_plots()
Write standard plots for a heteff_fit

Main plots

plot_observational_dag()
Plot the observational causal DAG
plot_instrumental_dag()
Plot the instrumental DAG
plot_treatment_outcome()
Plot the treatment-outcome relationship for an observational workflow
plot_first_stage()
Plot the first-stage treatment-instrument relationship
plot_reduced_form()
Plot the reduced-form outcome-instrument relationship
plot_subgroup_effects()
Plot subgroup mean effects
plot_effect_tree()
Plot an explanation tree with a publication-style layout
plot_variable_importance()
Plot ranked variable importance

Example data

simulate_observational_data()
Simulate data for an observational causal-forest workflow
simulate_survival_data()
Simulate data for a survival-forest workflow
simulate_instrumental_data()
Simulate data for an instrumental-forest workflow
prepare_case_nhefs()
Prepare the NHEFS observational case study
prepare_case_nsw()
Prepare the NSW observational case study
prepare_case_veteran()
Prepare the veteran survival case study
prepare_case_rotterdam()
Prepare the Rotterdam survival case study
prepare_case_card_data()
Prepare the Card returns-to-schooling case study
prepare_case_schooling_returns()
Prepare the SchoolingReturns case study

Supplementary helpers

print(<heteff_fit>)
Print a heteff_fit summary
plot(<heteff_fit>)
Plot a default subgroup-effect summary from a heteff_fit
plot_effect_distribution()
Plot the distribution of estimated sample-level effects
build_instrument_score()
Build a single instrument score from multiple columns
explain_effect_shap()
Compute SHAP-style explanations for fitted local IV effects
summarize_shap()
Summarize SHAP values into a ranked importance table
plot_shap_importance()
Plot ranked SHAP importance
fit_causal_tree_explorer()
Run a causalTree-style exploratory analysis
plot_causal_tree_explorer()
Plot a causalTree explorer result