Install | 1. Create the package | 2. Bring in the raw data | 3. Write the dictionary | 4. Generate the roxygen documentation | 5. Complete DESCRIPTION | 6. Generate the metadata | 7. Write the README | 8. Build the website | 9. Cite and release | Running steps again | More than one dataset | Publishing outside openwashdata
Package: washr 1.2.2
Lars Schöbitz
washr: Publication Toolkit for Water, Sanitation and Hygiene (WASH) Data
A toolkit to set up an R data package in a consistent structure. Automates tasks like tidy data export, data dictionary documentation, README and website creation, and citation management.
Authors:
washr_1.2.2.tar.gz
washr_1.2.2.zip(r-4.7-any)washr_1.2.2.zip(r-4.6-any)washr_1.2.2.zip(r-4.5-any)
washr_1.2.2.tgz(r-4.6-any)washr_1.2.2.tgz(r-4.5-any)
washr_1.2.2.tar.gz(r-4.7-any)washr_1.2.2.tar.gz(r-4.6-any)
washr_1.2.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
washr/json (API)
| # Install 'washr' in R: |
| install.packages('washr', repos = c('https://openwashdata.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/openwashdata/washr/issues
Pkgdown/docs site:https://openwashdata.github.io
Last updated from:369936ae0a. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 207 | ||
| source / vignettes | OK | 218 | ||
| linux-release | OK | 213 | ||
| macos-release | OK | 156 | ||
| macos-oldrel | OK | 130 | ||
| windows-devel | OK | 190 | ||
| windows-release | OK | 162 | ||
| windows-oldrel | OK | 182 | ||
| wasm-release | OK | 136 |
Exports:check_publication_readinesssetup_cisetup_dictionarysetup_rawdatasetup_readmesetup_roxygensetup_websiteupdate_citationupdate_descriptionupdate_dictionaryupdate_metadataupdate_websiteupdate_zenodo_jsonuse_brand
Dependencies:askpassbase64encbriobslibcachemcallrcffrclicliprcpp11crayoncredentialscurldescdigestdownlitevaluatefansifastmapfontawesomefsgertgitcredsgluehighrhtmltoolshttr2inijquerylibjsonlitejsonvalidateknitrlifecyclemagrittrmemoisemimeopensslotelpakpillarpkgconfigpkgdownprocessxpspurrrR6raggrappdirsRcpprlangrmarkdownrprojrootrstudioapisassstringisyssystemfontstextshapingtibbletinytexusethisutf8V8vctrswhiskerwithrxfunxml2yamlzip
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Check whether the data package is ready for publication | check_publication_readiness |
| Set up the R CMD check workflow for the data package | setup_ci |
| Create a dictionary file for tidy data sets | setup_dictionary |
| Create the data-raw directory with a data-processing.R template | setup_rawdata |
| Generate the README RMarkdown file | setup_readme |
| Set up roxygen documentation for all tidy data sets using the dictionary | setup_roxygen |
| Set up a pkgdown website for the data package | setup_website |
| Update the citation file for the dataset. | update_citation |
| Update the DESCRIPTION file to conform with openwashdata standards | update_description |
| Bring the dictionary in line with the tidy data | update_dictionary |
| Generate and embed the schema.org metadata of the data package | update_metadata |
| Bring an existing _pkgdown.yml in line with the washr template | update_website |
| Write the Zenodo metadata file of the data package | update_zenodo_json |
| Install or refresh the openwashdata brand in the active package | use_brand |