Taking Template public

[jmshapir]

@veli-m-andirin @rcalvo12 I am planning to take the Template public. Do you know of any reason not to do that? Thanks!

[veli-m-andirin]

Thanks @jmshapir!

I don't see any reason not to do that. We may want to carefully cite World Bank since the figures in the sample figure were constructed using their data. (We currently just say "Source: World Bank" under figure notes.

Speaking of that, we may also want to move the datastore to source/raw for completeness, since the files there only takes up ~500 KBs and are all CSVs, including the metadata files. We can also make the Drive folder publicly available, too.

[jmshapir]

Thanks @veli-m-andirin!

We may want to carefully cite World Bank since the figures in the sample figure were constructed using their data. (We currently just say "Source: World Bank" under figure notes.

Since we have detailed provenance in the readme in the raw directory, I think this is ok.

Speaking of that, we may also want to move the datastore to source/raw for completeness, since the files there only takes up ~500 KBs and are all CSVs, including the metadata files. We can also make the Drive folder publicly available, too.

I somewhat prefer making the drive folder public to illustrate how we work with gdrive. Is there any restriction that would prevent us from making the World Bank data public?

[veli-m-andirin]

Thanks @jmshapir!

Here is the terms of use for World Bank data. (I will add this to our docs as well, it is currently missing.)

According to it,

Unless indicated otherwise in the data or indicator metadata, you are free to copy, distribute, adapt, display or include the data in other products for commercial or noncommercial purposes at no cost under a Creative Commons Attribution 4.0 International License, with the additional terms below. The basic terms may be accessed here

Hence, my reading is that we are free to make the World Bank data public.

One note is that they seem to suggest a specific formatting for attribution:

You must include attribution for the data you use in the manner indicated in the metadata included with the data. Generally, you agree to provide attribution to The World Bank and its data providers in the following format: The World Bank: Dataset name: Data source (if known).

I can do this either in the figure notes or in the readme of the raw directory.

Keeping the drive folder for illustrative purposes makes sense to me.

[jmshapir]

Thanks @veli-m-andirin! Updating the readme of the raw directory with that attribution info sounds great to me. Please let me know when that's done.

@rcalvo12 please let us know if you have any concerns, otherwise I'll take this public once @veli-m-andirin has updated the readme.

Thanks both!

[veli-m-andirin]

Thanks @jmshapir! I updated the readme of the raw directory based on metadata files in docs, in line with the requirements given in terms of use. (I also uploaded the terms of use to docs.)

[rcalvo12]

@jmshapir I don't see any issues with taking it public now that the readme has been updated by @veli-m-andirin .

[jmshapir]

Thread continues in its pull request #54.

[jmshapir]

Summary: In this issue we prepared to take the Template public. It is now. Changes to readme merged into main branch in fd9ad15.