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

Initial documentation and data fetching guide (with examples) #10

Merged
merged 5 commits into from
Feb 3, 2023

Conversation

lee14257
Copy link

@lee14257 lee14257 commented Jan 13, 2022

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

@lee14257 lee14257 marked this pull request as draft January 13, 2022 19:43
@lee14257 lee14257 marked this pull request as ready for review January 18, 2022 17:24
@lee14257 lee14257 marked this pull request as draft January 27, 2022 20:06
@lee14257 lee14257 linked an issue May 23, 2022 that may be closed by this pull request
@lee14257 lee14257 requested a review from krivard May 24, 2022 00:53
@lee14257 lee14257 changed the title Update docs: data source tables, data fetching guide + examples Initial documentation and data fetching guide (with examples) May 24, 2022
@lee14257 lee14257 marked this pull request as ready for review May 24, 2022 00:53
@krivard krivard changed the base branch from dev to package-intro February 3, 2023 16:11
@krivard krivard merged commit 3e3ab0b into cmu-delphi:package-intro Feb 3, 2023
dshemetov added a commit that referenced this pull request May 6, 2024
Redo of #10: Initial documentation and data fetching guide (with examples)
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