Merge pull request #9 from openwashdata/dev

Release 0.1.0: remove list-columns from datasets

Author: larnsce

CITATION.cff

@@ -9,7 +9,7 @@ type: software
 license: CC-BY-4.0
 title: 'washopenresearch: Dataset about open research data information in Water, Sanitation,
   and Hygiene'
-version: 0.0.1
+version: 0.1.0
 doi: 10.5281/zenodo.11185699
 abstract: The goal of washopenresearch is to provide an overview of open research
   data related to Water Sanitation and Hygiene (WASH). The package provides access
@@ -32,7 +32,7 @@ authors:
   orcid: https://orcid.org/0000-0003-2196-5015
 repository-code: https://github.com/openwashdata/washopenresearch
 url: https://github.com/openwashdata/washopenresearch
-date-released: '2024-05-13'
+date-released: '2026-07-07'
 contact:
 - family-names: Zhong
   given-names: Mian

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: washopenresearch
 Title: Dataset about open research data information in Water, Sanitation, and Hygiene
-Version: 0.0.1
+Version: 0.1.0
 Authors@R: c(
     person("Mian", "Zhong", , "mzhong@ethz.ch", role = c("aut", "cre"),
            comment = c(ORCID = "0009-0009-4546-7214")),
@@ -13,11 +13,11 @@ Description: The goal of washopenresearch is to provide an overview of open rese
 License: CC BY 4.0
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
 Depends: 
-    R (>= 2.10)
+    R (>= 3.5)
 LazyData: true
 Config/Needs/website: rmarkdown
-Date: 2024-05-13
+Date: 2026-07-07
 URL: https://github.com/openwashdata/washopenresearch
 BugReports: https://github.com/openwashdata/washopenresearch/issues
+Config/roxygen2/version: 8.0.0

NEWS.md

@@ -0,0 +1,17 @@
+# washopenresearch 0.1.0
+
+## Breaking changes
+
+- `washdev` and `uncnewsletter` no longer contain list-columns (#8). The multi-value variables `supp_file_type`, `supp_url`, `das_repo_url`, and `keywords` are now character columns in which multiple values are separated by `"; "`. Flat-file exports such as `write.csv()` now work directly on both datasets. Code that used `tidyr::unnest()` or `unlist()` on these columns should split the strings instead, for example with `tidyr::separate_rows(supp_file_type, sep = "; ")` or `stringr::str_split(keywords, "; ")`.
+- `Depends` was raised from R (>= 2.10) to R (>= 3.5), required by the serialization format of the regenerated data files.
+
+## Minor improvements and fixes
+
+- The CSV and XLSX exports in `inst/extdata/` now show multi-value cells as `"; "`-separated strings instead of R code literals such as `c("pdf", "docx")`.
+- The variable descriptions in the package documentation and the data dictionary describe the new delimited format and the correct variable types.
+- The article "Missed Opportunity: where is WASH research data gone?" uses `tidyr::separate_rows()` in place of `tidyr::unnest()` to expand `supp_file_type`.
+- The word cloud figure in the README has alt text.
+
+# washopenresearch 0.0.1
+
+- Initial release with the `washdev` and `uncnewsletter` datasets on data availability statements in WASH research publications.

R/uncnewsletter.R

@@ -13,8 +13,8 @@
 #'   \item{published_year}{Year of publication}
 #'   \item{is_supp}{Whether the paper has supplementary materials}
 #'   \item{num_supp}{Number of supplementary material files}
-#'   \item{supp_file_type}{File type of the supplementary materials}
-#'   \item{supp_url}{Website url of the supplementary materials}
+#'   \item{supp_file_type}{File types of the supplementary materials, separated by "; " when there are multiple}
+#'   \item{supp_url}{Website urls of the supplementary materials, separated by "; " when there are multiple}
 #'   \item{num_authors}{Number of the authors}
 #'   \item{first_author_name}{Name of the first author}
 #'   \item{first_author_affiliation}{Academic affiliation of the first author}
@@ -29,7 +29,7 @@
 #'   \item{has_das}{Whether the paper has a data availability statement}
 #'   \item{das}{Original data availability statement of the paper. NA if it does not have a data availability statement.}
 #'   \item{das_type}{Type of the data availability statement including in paper(data in full paper scope like supplementary material or appendix or main content) on request(data available on request to the authors) available in online repository(data is shared in a public online repository) not shareable(data is not shareable). NA if it does not have a data availability statement.}
-#'   \item{das_repo_url}{Website url of the data if the relevant data of the paper is shared on a public repository}
-#'   \item{keywords}{List of keywords of the paper}
+#'   \item{das_repo_url}{Website urls of the data if the relevant data of the paper is shared on a public repository, separated by "; " when there are multiple}
+#'   \item{keywords}{Keywords of the paper, separated by "; "}
 #' }
 "uncnewsletter"

R/washdev.R

@@ -12,8 +12,8 @@
 #'   \item{published_year}{Year of publication}
 #'   \item{is_supp}{Whether the paper has supplementary materials}
 #'   \item{num_supp}{Number of supplementary material files}
-#'   \item{supp_file_type}{File type of the supplementary materials}
-#'   \item{supp_url}{Website url of the supplementary materials}
+#'   \item{supp_file_type}{File types of the supplementary materials, separated by "; " when there are multiple}
+#'   \item{supp_url}{Website urls of the supplementary materials, separated by "; " when there are multiple}
 #'   \item{num_authors}{Number of the authors}
 #'   \item{first_author_name}{Name of the first author}
 #'   \item{first_author_affiliation}{Academic affiliation of the first author}
@@ -28,7 +28,7 @@
 #'   \item{has_das}{Whether the paper has a data availability statement}
 #'   \item{das}{Original data availability statement of the paper.  NA if it does not have a data availability statement.}
 #'   \item{das_type}{Type of the data availability statement including in paper(data in full paper scope like supplementary material or appendix or main content) on request(data available on request to the authors) available in online repository(data is shared in a public online repository) not shareable(data is not shareable). NA if it does not have a data availability statement.}
-#'   \item{das_repo_url}{Website url of the data if the relevant data of the paper is shared on a public repository}
-#'   \item{keywords}{List of keywords of the paper}
+#'   \item{das_repo_url}{Website urls of the data if the relevant data of the paper is shared on a public repository, separated by "; " when there are multiple}
+#'   \item{keywords}{Keywords of the paper, separated by "; "}
 #' }
 "washdev"

README.Rmd

@@ -46,7 +46,7 @@ contains two datasets from the following sources:
     Water
     News](https://waterinstitute.unc.edu/our-work/nc-water-news-newsletter)
 
-![](man/figures/washdev_wordcloud.png){width="515"}
+![Word cloud of the most frequent keywords in articles of the Journal of Water, Sanitation and Hygiene for Development, with water, sanitation, and hygiene appearing largest](man/figures/washdev_wordcloud.png){width="515"}
 
 ## Installation
 
@@ -174,6 +174,7 @@ calculate their frequency to be used.
 
 ```{r washdev_keyword_frequency, echo=TRUE}
 keywords_freq <- washdev$keywords |>
+    str_split("; ") |>
     unlist() |>
     str_to_lower() |>
   table() |>