Release washr 1.0.0

[bonschorno]

First release:

• usethis::use_news_md()
• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks
• Update "Get started" vignette

Prepare for release:

• git pull
• usethis::use_github_links()
• urlchecker::url_check()
• devtools::build_readme()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('major')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• Finish & publish blog post
• Add link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• usethis::use_news_md()
• Share on social media

[larnsce]

Review washr package

README

• Switch maintainer to @bonschorno
• README still shows openwashdata-dev/washr for installation
• Hyperlink "Get Started" page in README (update: link to publishing guide. see comment below)

Get started page: https://openwashdata.github.io/washr/articles/washr.html

• Add the missing step before "After initializing an R package named with fssample with devtools" (this step is missing and I would not know how to start here without it). It needs a detailed description with screenshots on how people setup a repo on GitHub (especially for the detailed guide: Add more details for users to create a repository on GitHub Global-Health-Engineering/ghedatapublishing#4)
• Missing step for adding data to data-raw. The user need to know that they have to add their data to this folder and then use the data_processing.R script to prepare it. The descriptions here are not sufficient.
• Under "communicate dataset" it is not cleat that build_readme() is from devtools and not from washr. Make it explicit with devtools::build_readme()

The Get started page is currently not useful for someone discovering and wanting to use this package. It needs the whole guide for it to make sense, including all sub-steps of working with the description, updating the dictionary, etc.

I understand that you tried to list the most crucial steps, but it created too much confusion at the moment. I would rather remove that Get Started page, update the data publishing guide to reflect openwashdata users as the target audience and then link to the guide.

data_processing.R Skript

• Script uses data_in as the object name for reading data. Under the "Tidy data" section, there needs to be at least the step of whatawaste <- data_in, so that if no cleaning is required, the script runs through without an error. That would assume that the data resource has the same name as the data package. Both the guide and the Get Started page need more detailed information about naming the objects.