# synth_runner

**Repository Path**: arlionn/synth_runner

## Basic Information

- **Project Name**: synth_runner
- **Description**: A tool to run a pool of synthetic controls, conduct inference, and produce visualizations.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 3
- **Created**: 2021-03-25
- **Last Updated**: 2022-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

synth_runner
========

Automation for multiple Synthetic Control estimations in Stata.

Installation
=======

As a pre-requisite, the `synth` package needs to be installed. (The `all` option is necessary to install the accompanying dataset used in further examples.)

```Stata
. ssc install synth, all
```

To install the `synth_runner` package with Stata v13 or greater

```Stata
. cap ado uninstall synth_runner //in-case already installed
. net install synth_runner, from(https://raw.github.com/bquistorff/synth_runner/master/) replace
```

For Stata version <13, use the "Download ZIP" button above, unzip to a directory, and then replace the above `net install` with

```Stata
. net install synth_runner, from(full_local_path_to_files) replace
```

Usage
=======
Note: that the `synth` package's dataset might have a different name. It was originally uploaded as `smoking`, then for a while the dataset installed was incorrect (there was a name collision with another package), and now the dataset is correct and named `synth_smoking`.
```
sysuse synth_smoking, clear
tsset state year
synth_runner cigsale beer(1984(1)1988) lnincome(1972(1)1988) retprice age15to24 cigsale(1988) cigsale(1980) cigsale(1975), ///
	trunit(3) trperiod(1989) gen_vars
single_treatment_graphs, trlinediff(-1) raw_gname(cigsale1_raw) ///
	effects_gname(cigsale1_effects) effects_ylabels(-30(10)30) effects_ymax(35) effects_ymin(-35)

effect_graphs , trlinediff(-1) effect_gname(cigsale1_effect) tc_gname(cigsale1_tc)
	
pval_graphs , pvals_gname(cigsale1_pval) pvals_std_gname(cigsale1_pval_t)
```

Help
=======
See the [HTML version of the package help](https://rawgit.com/bquistorff/synth_runner/master/code/ado/synth_runner.html) for more info.

Contributing
=======
If you think you've encountered a bug, try installing the latest version. If it still persists see if an existing issue notes this problem. If the problem is new, file a [new issue](https://github.com/bquistorff/synth_runner/issues/new) and filling out the checklist so that there is enough information to diagnose the issue.

For developement, there are additional dependencies. If you change help files you will need the package. `bash`/`make` are optional (you can look through the makefile and manually run those tasks).