From 4bc7f07b7556ff7a70a76e22dcccfd3e1a7c708d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rok=20Ro=C5=A1kar?= <rok.roskar@sdsc.ethz.ch> Date: Fri, 20 Mar 2020 08:59:13 +0000 Subject: [PATCH] docs: improve the readme --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 62 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6094c0c4..48bce091 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,77 @@ -# covid-19-public-data +# Covid-19 Public Data Collaboration Project -A Renku project for aggregating data from various covid-19 public data sources. +This project aggregates data from various public data sources to better +understand the spread and effect of covid-19. The goal is to provide a central +place where data, analysis, and discussion can be conducted and shared by a +global community struggling to make sense of the current public health +emergency. -See [Dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) for a summary of the data. +See the [dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) +for a summary of the global data. -# Contributing +## Getting started -If you are interested in working on this project, we would love to get contributions. An easy contribution would be to add identifying and/or adding new data sources. See the section [Adding a new data source](#adding-a-new-data-source) +The simplest way to start is to make an account or logging in and forking the +project. Then, feel free to start an interactive environment (`Environments` --> +`New`) and use the hosted JupyterLab or RStudio to explore the data. A summary +of the data is given below. Please please please consider contributing back cool +results from your fork! If you don't know how or just need help with some of the +git-heavy aspects of this, shoot us a line at https://renku.discourse.group or +open an issue (`Collaboration` --> `Issues`) and someone will be able to help +out. -# Current Data Sources -## Covid-19 +## Dataset Summary -- [Covid-19 Data Repository by Johns Hopkins CSSE](https://github.com/CSSEGISandData/COVID-19) -- [Covid tracking crowdsourcing project](https://covidtracking.com/) -- [OpenData Zuerich](https://github.com/openZH/covid_19) +| Source | Dataset | Location | Example | +| ------ | ------- | -------- | ------- | +| [Covid-19 Data Repository at JHU CSSE](https://github.com/CSSEGISandData/COVID-19) | [covid-19_jhu-csse](https://renkulab.io/projects/covid-19/covid-19-public-data/datasets/f6726a5b-f973-45d5-b873-30fa0dff772f/) | `data/covid-19_jhu-csse` | [dashboard](https://renkulab.io/projects/covid-19/covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) +| [covidtracking.com](https://covidtracking.com/) | [covidtracking](https://renkulab.io/projects/covid-19/covid-19-public-data/datasets/c8bec148-5332-4602-9dc3-e39bbe92ed67/) | `data/covidtracking` | [notebook](https://renkulab.io/projects/covid-19/covid-19-public-data/files/blob/notebooks/examples/covidtracking-example.ipynb) | +| [OpenData Zuerich](https://github.com/openZH/covid_19) | [openzh-covid-19](https://renkulab.io/projects/covid-19/covid-19-public-data/datasets/c9295d7a-0380-4a1b-8731-5c36d76cb8e7/) | `data/openzh-covid-19` | [notebook](https://renkulab.io/projects/covid-19/covid-19-public-data/files/blob/notebooks/examples/openzh-covid-19-example.ipynb) +| [Covid-19 data for Italy](https://github.com/pcm-dpc/COVID-19) | [covid-19-italy](https://renkulab.io/projects/covid-19/covid-19-public-data/datasets/286c58b1-dbbc-4caa-a23a-fcb001d5ac51/) | `data/covid-19-italy` | N/A | -## General +### Covid-19 Data Repository JHU CSSE + +This is a global Covid-19 dataset updated regularly from [Johns Hopkins +University Center for Systems Science and Engineering (JHU +CSSE)](https://github.com/CSSEGISandData/COVID-19). The +[dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) summarizes +this data in combination with population data from the world bank. + +### Covid tracking crowdsourcing project + +[Covid tracking](https://covidtracking.com) is a crowd-sourced dataset for US state-level data. It is updated by hand by an army of volunteers. + +### OpenData Zuerich + +The [swiss cantonal data](https://github.com/openZH/covid_19) collected by the Zürich statistical office. Parts are updated manually, others are starting to become automated. + +### Case data for Italy + +Detailed data compiled by the [Civil Protection of Italy](https://github.com/pcm-dpc/COVID-19). + +### General - https://data.worldbank.org/indicator/SP.POP.TOTL - https://worldmap.harvard.edu/data/geonode:country_centroids_az8 -# Data Sources to Add +## Derived Dataset Summary + +| Dataset | Location | Code | +| ------- | -------- | ---- | +| Case population rates | `data/covid-19_rates` | [notebooks/process/ToRates.ipynb](https://renkulab.io/projects/covid-19/covid-19-public-data/files/blob/notebooks/process/ToRates.ipynb) + +## Contributing + +If you are interested in working on this project, we would love to get +contributions. We would really like to collect more data sources and make them +available here! Please provide ideas for data sources that are relevant to +understanding covid-19. + +If you want to add a new datasource yourself, see the section [Adding a new data +source](#adding-a-new-data-source) + +## Data Sources to Add See the [data sources issue](https://renkulab.io/projects/covid-19/covid-19-public-data/collaboration/issues/1/). -- GitLab