Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate dataframe creation #6

Open
miriamasagold opened this issue Aug 25, 2023 · 0 comments
Open

Deprecate dataframe creation #6

miriamasagold opened this issue Aug 25, 2023 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@miriamasagold
Copy link
Owner

  • The point of this package is to provide a lightweight convenience wrapper around the Congress API, so that users can get the data without needing to how how to make API requests.
  • Because of this design goal, I use as few depends as possible (just utils, httr, and jsonlite). This helps avoid any back compatibility issues with the everchanging Tidyverse ecosystem.
  • And yet, version 0.1.0 tries to provide a tidy project, with a return.data argument meant to create tidy dataframes for users out of the box.
  • Having set this project aside for a year to see how the Congress API evolves, it's obvious that the interface is not stable. Almost all of the endpoints' contents have changed in ways that break the congress_data() function.
  • This package's value is its lightweightness. Users that want a tidy object (with lots of tidyverse dependencies) can use Chris Kenny's package.
  • In sum, congress_data() and its methods should be deprecated in favor of just returning either a) the raw response object, or b) the raw "content" dataframe within resp
@miriamasagold miriamasagold added the bug Something isn't working label Aug 25, 2023
@miriamasagold miriamasagold self-assigned this Aug 25, 2023
miriamasagold added a commit that referenced this issue Aug 26, 2023
…' dataframes so minimize breakage as the Congress team updates its API format over time.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant