ropensci-archive / intern

:no_entry: ARCHIVED :no_entry:
0 stars 0 forks source link

Improving documentation: Better description of data sources in READMEs #5

Open cboettig opened 7 years ago

cboettig commented 7 years ago

Many rOpenSci packages access data from some online data provider. Quite a few of the package READMEs provide only a minimal explanation of the data provider, such as an acronym that may be familiar mostly to specialists. For example, see:

All READMEs that access data from an online provider should begin with a short description of the data provider and the kind of data being accessed, including a link to the data service showing a user where they can get more background information (e.g. https://github.com/ropensci/rusda has a nice description already).

Intern should send Pull Requests editing the .Rmd README files of each such repository to provide a good description and appropriate link.