Skip to content

Redo of #10: Initial documentation and data fetching guide (with examples) #19

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

Merged
merged 6 commits into from
May 6, 2024

Conversation

krivard
Copy link
Contributor

@krivard krivard commented Feb 3, 2023

#10 got clobbered by more-recent work so I resolved conflicts but got turned around part way through and now there's a local branch that should probably be reviewed by someone with more recent experience in epidat*. Probably low-pri?

Woochan's original text below:


Summary:

This PR aims to add a basic starter documentation in Sphinx to help understand what this package does and how it works. The main focus is on using the Epidata object that covers all the API endpoints. More work should be done to understand the COVIDcast segment of the code (which seems to be an extra add-on).

  • Added data source tables containing appropriate descriptions and hyperlinks leading to the main API documentation
  • Briefly tested the "EpiRange" parameter and added a short guide to the documentation
  • Added examples of API call and data parsing (CSV, JSON, Classic, etc.) for:
    • covidcast
    • wiki
    • fluview
  • Drafted data fetching guide using the Epidata object
  • Added descriptions and parameters for Epidata signal functions
    • Currently implemented for covidcast. If this is the correct direction, need to be done for all functions
  • "More on COVIDcast" section is written by a previous member. Will need to confirm if this section is needed.

Screen Shot 2022-05-22 at 10 30 04 PM

@krivard krivard requested a review from dshemetov February 3, 2023 16:34
@dshemetov dshemetov merged commit 0965453 into dev May 6, 2024
@dshemetov dshemetov deleted the package-intro branch May 6, 2024 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants