owid-grapher icon indicating copy to clipboard operation
owid-grapher copied to clipboard

Concept: downloading data from grapher should give a zip file with a README alongside csv

Open larsyencken opened this issue 2 years ago • 3 comments

Core problem

We want people to be able to reuse the data that we share wherever possible. To reuse the data properly, they need not only an interoperable format (a CSV file), but also information about:

  • How to cite the data (see: https://github.com/owid/owid-grapher/issues/1137)
  • What license the data is available under
  • What caveats the data comes with
  • A human-readable write-up of where the data came from (essentially, the Sources tab)

Proposed solution

Generate, for every grapher chart, a zip file containing the current CSV file and alongside it a README either in plaintext, markdown or PDF, which contains at minimum the contents of Sources.

Context

  • Currently, there is no permalink to the CSV files provided by grapher charts, since the CSV files themselves are generated dynamically on the browser
  • We could consider whether we can (or want to) dynamically generate this zip file, or whether we would prefer to bake it at site build time

larsyencken avatar Sep 26 '22 12:09 larsyencken

How about adding a python snippet for downloading the data programatically using owid-catalog-py?

Marigold avatar Sep 26 '22 12:09 Marigold

How about adding a python snippet for downloading the data programatically using owid-catalog-py?

Ah, that we could actually do much sooner! For many datasets, we could be baking that now.

larsyencken avatar Sep 26 '22 17:09 larsyencken

To fold this in to our Browsable Data Catalog and Future of Publishing discussions.

larsyencken avatar Oct 04 '22 10:10 larsyencken

Some feedback motivating this issue:

We recently had long conversations with the poverty data team at the World Bank where we discussed if they were happy with how we are using their work and citing them.

They were in general very happy. Their only feedback to us was that the data downloads from charts leave people a bit in the dark. For instance the version of the data is something they are now taking care to communicate. We note the version in the dataset-level metadata. But someone looking at the data after they downloaded it from a chart doesn't know the version.

JoeHasell avatar Nov 10 '22 23:11 JoeHasell

This issue has had no activity within 10 months. It is considered stale and will be closed in 7 days unless it is worked on or tagged as pinned.

github-actions[bot] avatar Sep 07 '23 07:09 github-actions[bot]