search

duarteguilherme / congressbr

An R package that returns tidy data from the APIs of the Brazilian Federal Senate and Chamber of Deputies.
https://robertmyles.github.io/congressbr/
Other
43 stars 6 forks source link
brasil brazil legislature r

readme

CRAN\_Status\_Badge Travis-CI Build Status AppVeyor Build Status CRAN\_Download\_Badge CRAN\_Download\_Badge

🇧🇷 congressbr

congressbr is a package for extracting data from the APIs of the Brazilian Federal Senate and Chamber of Deputies, respectively. You can read a paper about it in the Latin American Research Review here.

Installation

congressbr is on CRAN, and so can be installed with the following:

install.packages("congressbr")

Development versions can be installed with the devtools package:

devtools::install_github("RobertMyles/congressbr")

Function naming

We use a naming convention for functions that facilitates tab completion. All Senate-related functions start with sen_ and all Chamber-related ones start with cham_.

Principal functions

Vignettes

You can learn more about the package with the vignettes. Run vignette("Exploring the Brazilian Federal Senate") to download and explore data from the Federal Senate, and vignette("Exploring the Brazilian Chamber of Deputies") to do the same for the Chamber of Deputies.

Datasets

congressbr comes with some pre-prepared datasets.

Contributions

If you would like to get involved, feel free to fork the repo. We’ve been using the Udacity Git Commit Message Style Guide (well, not always). There are a list of open issues, which is a good place to start. The API of the Federal Senate is also under development, and so elements of this package may change. If you find any problems with the package, please open an issue and leave us a reproducible example and we’ll get it fixed asap.

Citation

If you use this package in academic work, it can be cited with:


citation("congressbr")

which will give you:

To cite package ‘congressbr’ in publications use:

  Robert Myles McDonnell, Guilherme Jardim Duarte and Danilo Freire (2017). congressbr:
  Downloads, Unpacks and Tidies Legislative Data from the Brazilian Federal Senate and
  Chamber of Deputies. R package version 0.1.0.
  https://CRAN.R-project.org/package=congressbr

A BibTeX entry for LaTeX users is

  @Manual{,
    title = {congressbr: Downloads, Unpacks and Tidies Legislative Data from the
Brazilian Federal Senate and Chamber of Deputies},
    author = {Robert Myles McDonnell and Guilherme Jardim Duarte and Danilo Freire},
    year = {2017},
    note = {R package version 0.1.0},
    url = {https://CRAN.R-project.org/package=congressbr},
  }

List of functions

For convenience, we list here the functions of the package. More details are available here. Note: The information returned by some of the functions below is no longer available from the API. Hopefully in a future release, we’ll be able to re-include these functions. (Functions are marked by strikethrough text.)