-
Notifications
You must be signed in to change notification settings - Fork 41
/
README.Rmd
79 lines (57 loc) · 3.49 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# gsynth
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#stablel)
[](https://opensource.org/licenses/MIT)
<!-- badges: end -->
**gsynth** implements the [generalized synthetic control method](https://doi-org.stanford.idm.oclc.org/10.1017/pan.2016.2), which imputes counterfactuals for each treated unit using control group information based on a linear interactive fixed effects model. This version supports unbalanced panels and implements the matrix completion method.
**Authors:** [Yiqing Xu](https://yiqingxu.org/) (Stanford), [Licheng Liu](https://polisci.mit.edu/people/licheng-liu) (MIT)
**Date:** Feb 22, 2022
**Repos:** [Github](https://github.com/xuyiqing/gsynth) (1.2.1)
[CRAN](https://cran.r-project.org/web/packages/gsynth/index.html) (1.2.1)
**Example:** R code used in the [tutorial](https://yiqingxu.org/packages/gsynth/articles/tutorial.html) can be downloaded from [here](https://yiqingxu.org/packages/gsynth/gsynth_examples.R).
---
## Installation
You can install **gsynth** directly from CRAN by typing the following command in the **R** console:
```{r eval=FALSE}
install.packages('gsynth', type = 'source')
```
You can also install the development version of the package from Github by typing:
```{r eval=FALSE}
install.packages('devtools', repos = 'http://cran.us.r-project.org') # if not already installed
devtools::install_github('xuyiqing/gsynth')
```
**gsynth** depends on the following packages, which will be installed automatically when **gsynth** is being installed; you can also install them manually:
```{r eval=FALSE}
## for processing C++ code
require(Rcpp)
## for plotting
require(ggplot2)
require(GGally)
## for parallel computing
require(foreach)
require(future)
require(doParallel)
require(abind)
require(lfe)
```
#### Notes on installation failures
1. Quick solution: download a binary build ([v.1.2.1](https://github.com/xuyiqing/gsynth/releases/download/1.2.1/gsynth_1.2.1.tgz)), which does not require compilation, and install it from file in RStudio.
2. Windows users please consider upgrading R to 4.0.0 or higher and installing the [latest Rtools](https://cran.r-project.org/bin/windows/Rtools/) to avoid C++17 complier errors when installing fastplm.
3. For Rcpp, RcppArmadillo and MacOS "-lgfortran" and "-lquadmath" error, click [here]( http://thecoatlessprofessor.com/programming/rcpp-rcpparmadillo-and-os-x-mavericks-lgfortran-and-lquadmath-error/) for details.
4. Installation failure related to OpenMP on MacOS, click [here](http://thecoatlessprofessor.com/programming/openmp-in-r-on-os-x/) for a solution.
5. To fix these issues, try installing gfortran 6.1 from [here]( https://gcc.gnu.org/wiki/GFortranBinaries#MacOS clang4 R Binaries from https://github.com/coatless/r-macos-clang).
6. Mac users who have updated to MacOS Big Sur will likely encounter compilation problems. See [here](http://yiqingxu.org/public/BigSurError.pdf) for a potential solution.
## Report bugs
Please report bugs to **yiqingxu [at] stanford.edu** with your sample code, data file, and a treatment status plot generated by [panelview](https://yiqingxu.org/packages/panelview/). Much appreciated!