Repository navigation
GitHub release. CRAN still serves washr 1.2.0; the CRAN submission of 1.3.0 follows later. Install this version with remotes::install_github("openwashdata/washr@v1.3.0").
New
check_publication_readiness()has a new item,version_follows_data. On a release version with a tagv<version>, it fails whendata/,inst/extdata/ordata-raw/dictionary.csvdiffer from that tag, uncommitted and untracked files included. An.rdafile counts as changed only when its objects differ, and an.xlsxfile ininst/extdata/only when the.csvfile of the same name changed too. The fix namesusethis::use_dev_version(), thenupdate_citation(build = FALSE)andupdate_metadata(). The item is not applicable on a development version, without git, without the tag (also in a shallow clone that lacks it) or when the package is not the root of its git repository. The vignette describes the rule behind it: the version of a data package changes only when the data, or their meaning, change (#163).data_availability_statement()drafts the text for the authors of an article that uses a data package, once the DOI is on file: the reference list entry in APA style (authors with rolesautandcrein Authors@R order, "&" before the last author, the first 19, an ellipsis and the last with more than 20, version,[Data set], the DOI link and the repository), the data availability statement (licence, package, version, DOI, the website for the CSV and Excel downloads) and the in-text citation ("Feni et al., 2026"). The opening words of the statement come from thesubjectargument ("The data" by default). An optional last sentence on data left out of the package comes from the new fieldConfig/washr/withheldin DESCRIPTION.clipboard = TRUEcopies the reference and the statement with clipr, a new Suggests. The function stops whenCITATION.cffcarries no DOI yet and warns on a development version (#155).- ROR identifiers in the schema.org metadata. The new field
Config/washr/parent-organizationsin DESCRIPTION names the organisations above the publisher, nearest first, asName <url>entries separated by semicolons.update_description()writes it with the other defaults: for openwashdata the chain Global Health Engineering (https://ghe.ethz.ch/), the Institute of Design, Materials and Fabrication (ROR 03zqk4w67) and ETH Zurich (ROR 05a28rw58), andnonefor another organisation.update_metadata()nests the chain under the publisher asparentOrganization, both for acphentity and for the organisation that stands in without one; ahttps://ror.org/URL becomes the@idof its entry, any other URL itsurl. An organisation entity inAuthors@R(cph,fnd) can carry its own ROR in the comment field,comment = c(ROR = "05a28rw58"), which becomes its@id.check_publication_readiness()has a new item,publisher_ror, which passes when the chain carries at least one ROR and is not applicable when the profile names none..zenodo.jsonandCITATION.cffare unchanged (#153). setup_rawdata()andsetup_readme()handle several datasets.setup_rawdata(datasets = )takes the names of the tidy data objects, writes oneusethis::use_data()line per dataset intodata-raw/data_processing.Rand exports each of them toinst/extdata/in one loop over the names; without it the one dataset is named after the package, as before, through the same loop. A name that is not a valid R name stops the run.setup_readme()writes one data section per object indata/, alphabetically, or for the objects named in its newdatasetsargument; with several objects the introduction names their number, the Example section keeps the first object, and an object without rows in the dictionary gets a warning. The README of a single dataset is unchanged. The hand edits the vignette described for a package with several datasets are no longer needed (#103).update_metadata()also writes the schema.org JSON-LD as a file,pkgdown/assets/metadata.jsonld, which pkgdown copies to the root of the site (<site>/metadata.jsonld). The file carries the same text as the JSON-LD in the head of the pages and is written only when it changed. The README template links it in one sentence of the Citation section when the package names its site, so the link reaches thellms.txtof the site.check_publication_readiness()has a new item,site_jsonld, which passes when the file is present and equals the JSON-LD in the page head, and is not applicable without_pkgdown.yml(#137).
Changed
update_zenodo_json(), and with itupdate_citation(), links the package website on the Zenodo record. The description gets a second paragraph, "Explore the data on a curated website", with the link, written as HTML, which Zenodo renders. The website is also a related identifier with the relationisDocumentedBy. The website is theurlin_pkgdown.yml, or else thegithub.ioentry of the DESCRIPTIONURLfield; without one, the description stays as it was. The repository link (isSupplementTo) is now written always, not only when the package names source articles. Existing packages get a new.zenodo.json:check_publication_readiness()reports thezenodo_jsonitem as differing untilupdate_citation()runs again, which belongs to the next release of each package (#154).update_dictionary()brings a dictionary in an older layout to the washr layout before it matches the rows to the data: an unnamed index column and unnamed empty columns are dropped,directoryandfile_nameare derived from the data objects when the file lacks them or holds placeholders (a variable that several data objects carry gets one row per object), the five washr columns come first and every other column keeps its place after them.update_metadata()then runs on those packages. A row whose variable no data object carries stops the run with the variable named.check_publication_readiness()accepts named columns after the five indictionary_schema, asupdate_dictionary()keeps them (#151).update_description()writesDateonce and then keeps it; a release sets the date on purpose with the newdateargument ("today"or aDate). The site branding passes had to restore the field on 59 packages whose data had not changed (#150).
Fixed
update_metadata()pins the download URLs of the JSON-LD (contentUrl) to the release tagv<version>, so a citation of a release gets the same files later. A development version still points at the main branch. It is the rule the README template uses for its download links (#137).setup_roxygen()no longer stops on its first call in a package without anR/folder; it creates the folder itself (#144).update_description(date = )with a value that is not"today", aDateor a"YYYY-MM-DD"string now stops with those accepted forms named, before the file is touched, in place of the error fromas.Date()(#150).