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

More compact and informative README #93

Open
5 of 6 tasks
jeanpaulrsoucy opened this issue Nov 30, 2022 · 0 comments
Open
5 of 6 tasks

More compact and informative README #93

jeanpaulrsoucy opened this issue Nov 30, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation P1 - High priority High priority updates

Comments

@jeanpaulrsoucy
Copy link
Member

jeanpaulrsoucy commented Nov 30, 2022

I've made a few commits recently aimed at making the README more compact, with the most relevant information out front, along with the making the docs directory more useful:

  • Moved the section "Detailed description of data sources" to docs/data_sources/data_sources.md (e908fdc)
  • Moved BibTeX citation file into docs/citation (725f3fd)
  • Moved the section "Transitioning from Covid19Canada" to docs/transitioning_from_Covid19Canada (386f97a)

There are a few other changes I'd like to make:

  • Turn "Available datasets" into a table with definitions for each metric, definitions for value and value_daily for each metric (Add better documentation of each value #51) and the file names for each geographic level (currently in "Included datasets" section)
  • Add more information on dates that provinces stopped reporting health region-level data (currently reported without date information in the "Getting started" section
  • Replacing the plots in the "Included datasets" section/the CovidTimelineCanadaPlots repository with a basic JavaScript dashboard (Create automatically updated github.io page #12)
  • Document the existence of and reasons for impossible values, rather than removing these by postprocessing (Postprocessing of raw data #1)
  • Add brief philosophy of dataset construction
  • Add brief history and alternative names for dataset (e.g., opencovid.ca dataset)
@jeanpaulrsoucy jeanpaulrsoucy added the documentation Improvements or additions to documentation label Nov 30, 2022
@jeanpaulrsoucy jeanpaulrsoucy pinned this issue Dec 9, 2022
@jeanpaulrsoucy jeanpaulrsoucy added the P1 - High priority High priority updates label Dec 9, 2022
jeanpaulrsoucy added a commit to ccodwg/Covid19CanadaBot that referenced this issue Dec 14, 2022
- Retire CovidTimelineCanadaPlots repository in favour of an automatically updated JavaScript dashboard (see ccodwg/CovidTimelineCanada#93 and ccodwg/CovidTimelineCanada#12)
jeanpaulrsoucy added a commit to ccodwg/CovidTimelineCanadaPlots that referenced this issue Dec 14, 2022
- Retire CovidTimelineCanadaPlots repository in favour of an automatically updated JavaScript dashboard (see ccodwg/CovidTimelineCanada#93 and ccodwg/CovidTimelineCanada#12)
jeanpaulrsoucy added a commit that referenced this issue Dec 14, 2022
- Remove plots from CovidTimelineCanadaPlots (#93)
- Add link to simple JavaScript dashboard (#12)
- Rename "Quick start guide" to "Getting started"
This was referenced Oct 11, 2023
jeanpaulrsoucy added a commit that referenced this issue Oct 14, 2023
…ng at HR level (#93)

- Also fix minor error in `data_sources.csv`
@jeanpaulrsoucy jeanpaulrsoucy unpinned this issue Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P1 - High priority High priority updates
Projects
None yet
Development

No branches or pull requests

1 participant