Data

Tools

Indexes

Applications

Experiments

Open Source Science

congress

Access the Congress.gov API

https://github.com/christopherkenny/congress

Science Score: 36.0%

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

  • ○
    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
    1 of 1 committers (100.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Access the Congress.gov API

Basic Info
Statistics
  • Stars: 15
  • Watchers: 2
  • Forks: 1
  • Open Issues: 1
  • Releases: 1
Created almost 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = '#>',
  fig.path = 'man/figures/README-',
  out.width = '100%'
)
```

# congress 


[![CRAN status](https://www.r-pkg.org/badges/version/congress)](https://CRAN.R-project.org/package=congress)
[![congress status badge](https://christopherkenny.r-universe.dev/badges/congress)](https://christopherkenny.r-universe.dev/congress)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/christopherkenny/congress/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/christopherkenny/congress/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/christopherkenny/congress/branch/main/graph/badge.svg)](https://app.codecov.io/gh/christopherkenny/congress?branch=main)


`congress` provides a *mostly* tidy interface to the Congress.gov API, available at .
It provides a simple R interface for downloading and working with actions, bills, nominations, and more from Congress.

## Installation

You can install the stable version of `congress` from [CRAN](https://CRAN.R-project.org/package=congress) with:

``` r
install.packages('congress')
```

You can install the development version of congress from [GitHub](https://github.com/) with:

``` r
# install.packages('devtools')
devtools::install_github('christopherkenny/congress')
```

## Example

To get the most recent `nomination`s, we can use the `cong_nomination()` function. By default, it gets the most recent 20. We request here, the most recent 10.

```{r example}
library(congress)

cong_nomination(limit = 10)
```

You can request up to 250 results, using `limit`. Once a request has been made, you can request the next set by using the `offset` argument:

```{r}
cong_nomination(limit = 10, offset = 10)
```

You can also request the next set using the `cong_request_next()` function:

```{r}
cong_nomination(limit = 10) |>
  cong_request_next()
```



## Supported Endpoints:

This package is designed for `v3` of the [Congress.gov API](https://github.com/LibraryOfCongress/api.congress.gov/). It currently supports the following endpoints:

- bills with `cong_bill()`
- amendments with `cong_amendment()`
- summaries with `cong_summaries()`
- congresses with `cong_congress()`
- members with `cong_member()`
- committees with `cong_committee()`
- committee reports with `cong_committee_report()`
- committee prints with `cong_committee_print()`
- committee meetings with `cong_committee_meeting()`
- Congressional Records with `cong_record()`
- Daily Congressional Records with `cong_daily_record()`
- Bound Congressional Records with `cong_bound_record()`
- House communications with `cong_house_communication()`
- Senate communications with `cong_senate_communication()`
- nominations with `cong_nomination()`
- treaties with `cong_treaty()`
- hearings with `cong_hearing()`

## Authentication

To sign up for an API key, visit the [Congress.gov API](https://api.congress.gov/sign-up/) sign-up website. 

Once you have your key, you can set it in your environment as `CONGRESS_KEY`.
You can:

1. Add this directly to your `.Renviron` file with a line like so

```r
CONGRESS_KEY='yourkey'
```

If doing this, I recommend using `usethis::edit_r_environ()` to ensure that you open the correct .Renviron file.

2. Set this in you current R session with `Sys.setenv(CONGRESS_KEY='yourkey')`.

3. Set this using the `congress::set_congress_key()` function. To save this for future sessions, run with `install = TRUE`.

Owner

  • Name: Christopher T. Kenny
  • Login: christopherkenny
  • Kind: user
  • Location: Cambridge, MA
  • Company: Harvard University

Redistricting and rstats. Harvard University, PhD Candidate, Department of Government. Cornell '19.

GitHub Events

Total
  • Issues event: 27
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 35
Last Year
  • Issues event: 27
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 35

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 45
  • Total Committers: 1
  • Avg Commits per committer: 45.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Christopher Kenny c****4@c****u 45
Committer Domains (Top 20 + Academic)
cornell.edu: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 39
  • Total pull requests: 0
  • Average time to close issues: about 2 months
  • Average time to close pull requests: N/A
  • Total issue authors: 6
  • Total pull request authors: 0
  • Average comments per issue: 0.46
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 21
  • Pull requests: 0
  • Average time to close issues: about 1 month
  • Average time to close pull requests: N/A
  • Issue authors: 4
  • Pull request authors: 0
  • Average comments per issue: 0.1
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • christopherkenny (33)
  • eteitelbaum (1)
  • Kenneth-TIAN (1)
  • jlynn2108 (1)
  • blackerby (1)
  • uctsk (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 677 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
cran.r-project.org: congress

Access the Congress.gov API

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 677 Last month
Rankings
Stargazers count: 28.5%
Forks count: 28.8%
Dependent packages count: 29.8%
Average: 32.2%
Dependent repos count: 35.5%
Downloads: 38.5%
Maintainers (1)
ctkenny@proton.me
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • R >= 4.1.0 depends
  • cli * imports
  • dplyr * imports
  • glue * imports
  • httr2 * imports
  • purrr * imports
  • rlang * imports
  • stringr * imports
  • tibble * imports
  • tidyr * imports
  • httptest2 * suggests
  • spelling * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite