| Title: | Publication Toolkit for Water, Sanitation and Hygiene (WASH) Data |
| Version: | 1.0.1 |
| Description: | 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. |
| License: | GPL (≥ 3) |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.3.2 |
| Imports: | desc (≥ 1.4.3), devtools (≥ 2.4.5), cffr (≥ 1.0.1), pkgdown (≥ 2.0.7), rlang (≥ 1.1.3), usethis (≥ 2.2.3), utils (≥ 4.3.3) |
| Language: | en-GB |
| Config/Needs/website: | rmarkdown |
| Date: | 2024-11-01 |
| URL: | https://openwashdata.github.io/washr/ |
| BugReports: | https://github.com/openwashdata/washr/issues |
| Suggests: | knitr, rmarkdown, testthat (≥ 3.2.1), withr (≥ 3.0.0) |
| Config/testthat/edition: | 3 |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Packaged: | 2024-11-05 12:05:48 UTC; cwalder |
| Author: | Mian Zhong  [aut],
Margaux Götschmann
[aut],
Colin Walder
[aut, cre],
Lars Schöbitz
[aut],
Global Health Engineering, ETH Zurich [cph] |
| Maintainer: | Colin Walder <cwalder@ethz.ch> |
| Repository: | CRAN |
| Date/Publication: | 2024-11-07 17:50:02 UTC |
Fill in the dictionary file based on the tidy data information
Description
Fill in the dictionary file based on the tidy data information
Usage
fill_dictionary(dict_path, data_dir)
Arguments
dict_path |
Path to the dictionary csvfile. |
data_dir |
Path to the directory of the tidy R data objects. Defaults to data/ |
Value
A tibble data frame of dataset dictionary with an empty description column to be written.
Examples
## Not run:
update_dictionary(dict_path = "data-raw/my-dictionary.csv", data = "data/")
## End(Not run)
Generate roxygen2 documentation from a CSV file
Description
This function takes a CSV table with columns variable_name and description as input,
optionally filters it by variable_name, and outputs roxygen2 documentation for \describe and \item.
Usage
generate_roxygen_docs(input_file_path, output_file_path, df_name = NULL)
Arguments
input_file_path |
Path to the input CSV file. |
output_file_path |
Path to the output file that will contain the roxygen2 documentation. |
df_name |
Optional name of the variable to filter the input dataframe by. Default is NULL. |
Value
Character string of a generated roxygen documentation.
Examples
## Not run:
# Generate roxygen2 documentation from example.csv
generate_roxygen_docs("example.csv", "output.R")
# Generate roxygen2 documentation from example.csv for a specific variable name
generate_roxygen_docs("example.csv", "output.R", df_name = "specific_variable")
## End(Not run)
Create a dictionary file for tidy data sets
Description
setup_dictionary() generates a dictionary CSV file in the
data/ directory. The dictionary file
contains information on the tidy data sets such as directory, file names, variable names,
variable types, and descriptions. If tidy data exists, the dictionary is populated with
relevant information; otherwise, it creates an empty dictionary CSV file.
Usage
setup_dictionary()
Value
NULL. Error if raw data is not found or not in a package directory.
Examples
## Not run:
setup_rawdata()
# Go to data_processing.R, clean the raw data and export tidy data
setup_dictionary()
## End(Not run)
Create the data-raw directory with a data-processing.R template
Description
setup_rawdata() creates a directory for raw data and an example script
named data_processing.R for importing, processing and exporting the tidy data.
The template assumes that the dataset name is the same as the data package name.
Usage
setup_rawdata()
Value
NULL. This function will create a directory "data-raw" under the package directory.
Examples
## Not run:
setup_rawdata()
## End(Not run)
Generate the README RMarkdown file
Description
setup_readme() uses the openwashdata README template to generate README files based on datasets
retrieved from the data/ directory. It helps in creating consistent and informative README documentation
for your data packages.
Usage
setup_readme()
Value
NULL. This function creates a README.Rmd under the package directory.
Examples
## Not run:
# Generate the README file after setting up the dictionary
setup_dictionary()
# Complete and save the dictionary CSV file with variable descriptions
setup_readme()
## End(Not run)
Set up roxygen documentation for all tidy data sets using the dictionary
Description
Creates or updates Roxygen documentation for all tidy data sets found in the dictionary file.
When first run, this function creates the Roxygen documentation with placeholders for the title and description field. The dictionary should include columns for directory, file name, variable name, variable type, and description. This function generates Roxygen comments with this information, facilitating consistent and thorough documentation for your data sets.
When re-run this function, this function updates only the variable description entries in the Roxygen documentation files within R/ directory. The title and description fields remain unchanged.
Usage
setup_roxygen()
Value
NULL. This function creates documentation files inside "R/". Error if tidy data cannot be found.
Examples
## Not run:
setup_dictionary()
# Once the dictionary is created, go to data-raw/dictionary.csv and complete the column description.
setup_roxygen()
## End(Not run)
Set up a pkgdown website for the data package
Description
setup_website() uses the openwashdata pkgdown template to create a website for the data package
based on its README.md file. The website provides a structured and visually appealing presentation
of the package's documentation.
Usage
setup_website(has_example = FALSE)
Arguments
has_example |
Logical. Should the pkgdown website include a vignette page for writing an example? Defaults to FALSE. |
Value
NULL. Error if no README file is found.
Examples
## Not run:
# Set up the pkgdown website including a vignette page
setup_website(has_example = TRUE)
## End(Not run)
Update the citation file for the dataset.
Description
Create a citation *.cff file for the released dataset from a given DOI(Digital Object Identifier). It adds the DOI badge to the README RMarkdown file and re-build the README.md and pkgdown website if exists.
Usage
update_citation(doi)
Arguments
doi |
DOI(Digital Object Identifier), e.g., 10.5281/zenodo.11185699 |
Value
NULL. A citation .cff file is written under the root directory.
Examples
## Not run:
update_citation(doi = "10.5281/zenodo.11185699")
## End(Not run)
Update the DESCRIPTION file to conform with openwashdata standards
Description
This function updates the DESCRIPTION file of an R package to comply with openwashdata standards.
It ensures that fields such as License, Language, Date, URL, and others are correctly specified.
Usage
update_description(
file = ".",
github_user = "https://github.com/openwashdata/"
)
Arguments
file |
Character. The file path to the DESCRIPTION file of the R package. Defaults to the current working directory. |
github_user |
Character. The URL path to the GitHub user or organization that hosts the current package. Defaults to "https://github.com/openwashdata". |
Value
NULL. Update fields directly in DESCRIPTION file.
Examples
## Not run:
# Update DESCRIPTION file in the current package
update_description()
# Update DESCRIPTION file in a specific package
update_description(file = "path/to/your/package/DESCRIPTION")
# Update DESCRIPTION file with a specific GitHub user
update_description(github_user = "https://github.com/yourusername")
## End(Not run)