# Bayesian Synthetic Control Models

## Documentation for package ‘bscm’ version 1.0.1

- DESCRIPTION file.
- Package NEWS.

## Help Pages

A B C D E F G H L M N P R S T

bscm-package | The 'bscm' package

## -- A --

as.data.frame | Extract posterior draws of model parameters as a data frame
as.data.frame.bscmfit | Extract posterior draws of model parameters as a data frame
as_draws | Return posterior draws from BSCM fit as a draws object
as_draws.bscmfit | Return posterior draws from BSCM fit as a draws object
average_treatment_effect | Pre- and post-treatment average effects of a Bayesian synthetic control model
average_treatment_effect.bscmfit | Pre- and post-treatment average effects of a Bayesian synthetic control model

## -- B --

bayes_R2 | Bayesian R-squared value
bayes_R2.bscmfit | Bayesian R-squared value
beta_pr | Prior distributions in the Bayesian synthetic control model
bscm | Estimate Bayesian synthetic control model
bscm_prior | Prior distributions in the Bayesian synthetic control model

## -- C --

check_mcmc_diagnostics | Check the validity of the posterior of 'bscmfit' object
check_mcmc_diagnostics.bscmfit | Check the validity of the posterior of 'bscmfit' object
coef | Extract regression coefficients of a Bayesian synthetic control model
coef.bscmfit | Extract regression coefficients of a Bayesian synthetic control model
covariate_adjustment | Covariate adjustments for Bayesian synthetic control model
covariate_adjustment.bscmfit | Covariate adjustments for Bayesian synthetic control model
covariate_imbalance | Covariate imbalance of Bayesian synthetic control model
covariate_imbalance.bscmfit | Covariate imbalance of Bayesian synthetic control model

## -- D --

dirichlet_pr | Prior distributions in the Bayesian synthetic control model
donor_ranking | Donor ranking
donor_weights | Extract donor weights of a Bayesian synthetic control model
donor_weights.bscmfit | Extract donor weights of a Bayesian synthetic control model

## -- E --

effective_donors | Extract the number of effective donors in a Bayesian synthetic control model
effective_donors.bscmfit | Extract the number of effective donors in a Bayesian synthetic control model
exponential_pr | Prior distributions in the Bayesian synthetic control model

## -- F --

fitted | Expected values of posterior predictive distribution of Bayesian synthetic control model
fitted.bscmfit | Expected values of posterior predictive distribution of Bayesian synthetic control model
fit_single_treated | Example bscmfit object

## -- G --

gamma_pr | Prior distributions in the Bayesian synthetic control model
get_priors | Get prior specifications used in the Bayesian synthetic control model
get_priors.bscmfit | Get prior specifications used in the Bayesian synthetic control model
get_refmodel | Create a projpred reference model from a BSCM fit
get_refmodel.bscmfit | Create a projpred reference model from a BSCM fit
get_standata | Get input data to Stan from 'bscmfit' object
get_stanfit | Extract the 'stanfit' object from the 'bscmfit' object
get_stanfit.bscmfit | Extract the 'stanfit' object from the 'bscmfit' object
get_stanfit.default | Extract the 'stanfit' object from the 'bscmfit' object

## -- H --

half_normal_pr | Prior distributions in the Bayesian synthetic control model

## -- L --

leave_donor_out | Leave-out donor sensitivity of a Bayesian synthetic control model
leave_donor_out.bscmfit | Leave-out donor sensitivity of a Bayesian synthetic control model
lfo | Leave-Future-Out Cross-Validation
lfo.bscmfit | Leave-Future-Out Cross-Validation
logistic_normal_pr | Prior distributions in the Bayesian synthetic control model
log_lik | Posterior draws of pointwise log-likelihood
log_lik.bscmfit | Posterior draws of pointwise log-likelihood
loo | Approximate leave-one-out (LOO) cross-validation for Bayesian synthetic control models
loo.bscmfit | Approximate leave-one-out (LOO) cross-validation for Bayesian synthetic control models
loo_R2 | Bayesian R-squared value
loo_R2.bscmfit | Bayesian R-squared value

## -- M --

multiple_treated | Simulated example data with multiple treated units

## -- N --

nchains | Return the number of chains of 'bscmfit' object
nchains.bscmfit | Return the number of chains of 'bscmfit' object
ndraws | Return the number of posterior draws of a 'bscmfit' object
ndraws.bscmfit | Return the number of posterior draws of a 'bscmfit' object
normal_pr | Prior distributions in the Bayesian synthetic control model

## -- P --

placebo_effects | Placebo effects of a Bayesian synthetic control model
placebo_effects.bscmfit | Placebo effects of a Bayesian synthetic control model
plot | Visualize BSCM estimates
plot.bscmfit | Visualize BSCM estimates
plot.bscm_lfo | Plot Pareto k diagnostics from LFO cross-validation
plot_coefs | Visualize regression coefficients of Bayesian synthetic control model
plot_coefs.bscmfit | Visualize regression coefficients of Bayesian synthetic control model
plot_effects | Visualize BSCM treatment effects
plot_effects.bscmfit | Visualize BSCM treatment effects
plot_effects.bscm_ldo | Visualize BSCM treatment effects
plot_effects.bscm_placebo_effects | Visualize BSCM treatment effects
plot_residuals | Visualize BSCM residuals
plot_residuals.bscmfit | Visualize BSCM residuals
plot_weights | Visualize donor weights
plot_weights.bscmfit | Visualize donor weights
plot_weights.bscm_ldo | Visualize donor weights
posterior_epred | Posterior Draws of the Expected Predictive Distribution
posterior_epred.bscmfit | Posterior Draws of the Expected Predictive Distribution
posterior_linpred | Posterior Draws of the Linear Predictor
posterior_linpred.bscmfit | Posterior Draws of the Linear Predictor
posterior_predict | Posterior Predictive Distribution of Bayesian Synthetic Control Model
posterior_predict.bscmfit | Posterior Predictive Distribution of Bayesian Synthetic Control Model
print.bscmfit | Print method for bscmfit objects
print.bscmfit_diagnostics | Print MCMC Diagnostics
print.bscm_lfo | Print method for LFO cross-validation output
print.summary_bscmfit | Print method for bscmfit objects
proj_predict_bscm | Predictions from a projected BSCM model

## -- R --

residuals | Posterior residuals of a Bayesian synthetic control model
residuals.bscmfit | Posterior residuals of a Bayesian synthetic control model
residual_acf | Autocorrelation function for residuals of BSCM
rmse | Extract root mean squared errors of a Bayesian synthetic control model
rmse.bscmfit | Extract root mean squared errors of a Bayesian synthetic control model
rmse_ratio | Extract the ratio of post- to pre-treatment RMSE
rmse_ratio.bscmfit | Extract the ratio of post- to pre-treatment RMSE

## -- S --

sigma | Extract residual standard deviations of a Bayesian synthetic control model
sigma.bscmfit | Extract residual standard deviations of a Bayesian synthetic control model
single_treated | Simulated example data with single treated unit
student_pr | Prior distributions in the Bayesian synthetic control model
summary | Summarise posterior draws of an estimated Bayesian synthetic control model
summary.bscmfit | Summarise posterior draws of an estimated Bayesian synthetic control model
synthetic_control | Synthetic control series of a Bayesian synthetic control model
synthetic_control.bscmfit | Synthetic control series of a Bayesian synthetic control model

## -- T --

treatment_effect | Treatment effect estimates of a Bayesian synthetic control model
treatment_effect.bscmfit | Treatment effect estimates of a Bayesian synthetic control model
tv | Define the time-varying coefficients for BSCM