pysyncon

A python module for the synthetic control method

https://github.com/sdfordham/pysyncon

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.4%) to scientific vocabulary

Keywords

augsynth causal-inference synth synthetic-control-method
Last synced: 6 months ago · JSON representation ·

Repository

A python module for the synthetic control method

Basic Info
  • Host: GitHub
  • Owner: sdfordham
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 2.58 MB
Statistics
  • Stars: 67
  • Watchers: 2
  • Forks: 16
  • Open Issues: 1
  • Releases: 11
Topics
augsynth causal-inference synth synthetic-control-method
Created about 3 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

pysyncon codecov

A python module for the synthetic control method that provides implementations of:

  • Synthetic Control Method (Abadie & Gardeazabal 2003)
  • Robust Synthetic Control Method (Amjad, Shah & Shen 2018)
  • Augmented Synthetic Control Method (Ben-Michael, Feller & Rothstein 2021)
  • Penalized Synthetic Control Method (Abadie & L'Hour 2021)

The package also provides methods for performing placebo tests and generating confidence intervals.

The implementation of the synthetic control method aims to be reconcilable with the R package Synth and similarly the implementation of the Augmented synthetic control method and the R package augsynth.

Installation

Install it from PyPI using pip:

bash python -m pip install pysyncon

Usage

Documentation is available on github-pages. In the examples folder are notebooks reproducing the weights from:

  • The Economic Costs of Conflict: A Case Study of the Basque Country, Alberto Abadie and Javier Gardeazabal; The American Economic Review Vol. 93, No. 1 (Mar., 2003), pp. 113-132. (notebook here)
  • The worked example 'Prison construction and Black male incarceration' from the last chapter of 'Causal Inference: The Mixtape' by Scott Cunningham. (notebook here)
  • Comparative Politics and the Synthetic Control Method, Alberto Abadie, Alexis Diamond and Jens Hainmueller; American Journal of Political Science Vol. 59, No. 2 (April 2015), pp. 495-510. (notebook here)

Citation

If you use this package in your research, you can cite it as below.

@software{pysyncon, author = {Fordham, Stiofán}, month = dec, title = {{pysyncon: a Python package for the Synthetic Control Method}}, url = {https://github.com/sdfordham/pysyncon}, year = {2022} }

Owner

  • Name: Stiofáin Fordham
  • Login: sdfordham
  • Kind: user
  • Location: Ireland

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software in your research, please cite it as below."
authors:
- family-names: "Fordham"
  given-names: "Stiofán"
  orcid: "https://orcid.org/0009-0003-1345-3252"
title: "pysyncon: a Python package for the Synthetic Control Method"
date-released: 2022-12-20
url: "https://github.com/sdfordham/pysyncon"

GitHub Events

Total
  • Create event: 5
  • Release event: 1
  • Issues event: 2
  • Watch event: 29
  • Delete event: 5
  • Issue comment event: 7
  • Push event: 11
  • Pull request event: 16
  • Fork event: 5
Last Year
  • Create event: 5
  • Release event: 1
  • Issues event: 2
  • Watch event: 29
  • Delete event: 5
  • Issue comment event: 7
  • Push event: 11
  • Pull request event: 16
  • Fork event: 5

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 150
  • Total Committers: 1
  • Avg Commits per committer: 150.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Stiofain s****f@g****m 150

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 71
  • Average time to close issues: 19 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 9
  • Total pull request authors: 4
  • Average comments per issue: 5.11
  • Average comments per pull request: 0.69
  • Merged pull requests: 67
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 14
  • Average time to close issues: about 4 hours
  • Average time to close pull requests: about 5 hours
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • abhishekparida2000 (1)
  • dhvalden (1)
  • felix-roc (1)
  • josealvarez97 (1)
  • arasala (1)
  • MJ-Hon (1)
  • SUonGH (1)
  • cuusa (1)
Pull Request Authors
  • sdfordham (86)
  • ConorMcNamara (4)
  • LukasHaas (2)
  • felix-roc (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,016 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 11
  • Total maintainers: 1
pypi.org: pysyncon
  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 2,016 Last month
Rankings
Dependent packages count: 6.6%
Average: 27.0%
Downloads: 28.2%
Forks count: 30.5%
Dependent repos count: 30.6%
Stargazers count: 39.1%
Maintainers (1)
Last synced: 7 months ago