Release epidict 0.1.0 - Githubissues

R4EPI / epidict

Epidemiology data dictionaries and random data generators

https://r4epi.github.io/epidict/

GNU General Public License v3.0

3 stars 1 forks source link

Release epidict 0.1.0 #7

Open zkamvar opened 4 years ago

zkamvar commented 4 years ago

Prepare for release:

[x] Check that description is informative
[x] Check licensing of included files
[x] usethis::use_cran_comments()
[x] devtools::check()
[x] devtools::check_win_devel()
[x] rhub::check_for_cran()
[x] Create vignettes
[x] Polish pkgdown reference index
[ ] Draft blog post

Submit to CRAN:

[x] usethis::use_version('minor')
[x] Update cran-comments.md
[ ] devtools::submit_cran()
[ ] Approve email

Wait for CRAN...

[ ] Accepted :tada:
[ ] usethis::use_github_release()
[ ] usethis::use_dev_version()
[ ] Update install instructions in README
[ ] Finish blog post
[ ] Tweet
[ ] Add link to blog post in pkgdown news menu

aspina7 commented 4 years ago

Index:

[x] could say something like: "This package provides standardized data dictionaries for four outbreak scenarios (Acute Jaundice Syndrome, Cholera, Measles, Meningitis) and three surveys (Retrospective mortality and access to care, Malnutrition, and Vaccination coverage) - currently based on MSF OCA dictionaries - other dictionaries are planned to be added shortly"

gen_data:

[x] all fine, examples a bit dense but assume that all the extra bits around dont show up on the user faacing side - all the withAutoprint stuff?

msf_dict:

[x] description: "The randomised dataset produced should mimic an excel export from DHIS2 for outbreaks and a Kobo export for surveys".
[x] arguments: disease: missing the survey options!
[x] same thing with examples as above (ignore if relevant)

website: good

otherwise peng

zkamvar commented 4 years ago

* all fine, examples a bit dense but assume that all the extra bits around dont show up on the user faacing side - all the withAutoprint stuff?

@aspina7, If we don't include the withAutoprint stuff, then the examples won't show up well on the site (they would only see the data sets print out sequentially).

zkamvar commented 4 years ago

[ ] arguments: disease: missing the survey options!

@aspina7, what do you mean here?

aspina7 commented 4 years ago

[ ] arguments: disease: missing the survey options! @aspina7, what do you mean here?

In the arguments section for diseases - it only lists measles ajs and cholera, but should also specify that for the survey dictionaries the options are mortality, vaccination, nutrition etc...

zkamvar commented 4 years ago

[ ] arguments: disease: missing the survey options! @aspina7, what do you mean here?

In the arguments section for diseases - it only lists measles ajs and cholera, but should also specify that for the survey dictionaries the options are mortality, vaccination, nutrition etc...

That's in msf_dict_survey(). We added those in because of the different tracks for processing survey dictionaries..

zkamvar commented 4 years ago

description: "The randomised dataset produced should mimic an excel export from DHIS2 for outbreaks and a Kobo export for surveys".

This makes me realize the description for this is wrong. It should indicate that it produces the dictionaries in an R-friendly manner.

aspina7 commented 4 years ago

In the arguments section for diseases - it only lists measles ajs and cholera, but should also specify that for the survey dictionaries the options are mortality, vaccination, nutrition etc...

That's in msf_dict_survey(). We added those in because of the different tracks for processing survey dictionaries..

Yap the help for msf_dict shows both linelist and survey options though - just the arguments section doesnt reflect that...