diff --git a/README.md b/README.md index ccde9818b448f4a57271b79e0fd6b0159482241c..09ae03241b54504c3a05bf6c53b9a94d6ddf9b3e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ A Renku project for aggregating data from various covid-19 public data sources. See [Dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) for a summary of the data. +# Contributing + +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) + # Current Data Sources ## Covid-19 @@ -19,4 +23,14 @@ See [Dashboard](covid-19-public-data/files/blob/runs/Dashboard.run.ipynb) for a - https://github.com/COVID19Tracking/covid-19-crawler - https://github.com/openZH/covid_19 -- https://github.com/pcm-dpc/COVID-19 \ No newline at end of file +- https://github.com/pcm-dpc/COVID-19 + +## Adding a new data source + +Adding a new data source is easy! To do so, in your fork or branch of the project, do the following: + +* Create a renku dataset using `renku dataset create [dataset name]` +* Add any files or folders using `renku dataset add`. [Looking in the commit history will provide some examples](https://renkulab.io/gitlab/covid-19/covid-19-public-data/commits/master). +* Create a notebook that shows how to read and work with the dataset in the `notebooks/examples` folder + * Protip: use a unique name for the notebook to avoid merge conflicts +* Add an issue to the project for any suggestions on things to do with the data diff --git a/notebooks/examples/README.md b/notebooks/examples/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a3b175d240803d4e56d68c8a38f5fd666a2c1ea6 --- /dev/null +++ b/notebooks/examples/README.md @@ -0,0 +1,3 @@ +# notebooks/examples + +This is a place for example notebooks explaining how to work with particular data sources. \ No newline at end of file