From e0befd0f5d8ffc8ded2570d66327b6629ef3cbda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Sch=C3=B6bitz?= Date: Tue, 26 Mar 2024 14:52:23 +0100 Subject: [PATCH] add doi and update documentation --- CITATION.cff | 10 ++++++---- DESCRIPTION | 2 +- README.Rmd | 1 + README.md | 15 +++++++------- data-raw/package_processing.R | 30 ++++++++++++++++++++++++++++ docs/404.html | 2 +- docs/LICENSE.html | 2 +- docs/authors.html | 12 ++++++----- docs/index.html | 27 +++++++++++++++---------- docs/pkgdown.yml | 2 +- docs/reference/df_aae.html | 2 +- docs/reference/df_collocation.html | 11 ++++++---- docs/reference/df_mm.html | 2 +- docs/reference/df_mm_road_type.html | 2 +- docs/reference/df_pm.html | 2 +- docs/reference/df_pm_trips.html | 2 +- docs/reference/df_sm.html | 2 +- docs/reference/index.html | 4 ++-- docs/search.json | 2 +- inst/CITATION | 31 ++++++++++++++++++++--------- inst/CITATION.bk1 | 19 ++++++++++++++++++ 21 files changed, 129 insertions(+), 53 deletions(-) create mode 100644 data-raw/package_processing.R create mode 100644 inst/CITATION.bk1 diff --git a/CITATION.cff b/CITATION.cff index fa69ab4..11a4be0 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,5 +1,5 @@ # ----------------------------------------------------------- -# CITATION file created with {cffr} R package, v0.5.0 +# CITATION file created with {cffr} R package, v1.0.0 # See also: https://docs.ropensci.org/cffr/ # ----------------------------------------------------------- @@ -7,8 +7,10 @@ cff-version: 1.2.0 message: 'To cite package "bcsa" in publications use:' type: software license: CC-BY-4.0 -title: 'bcsa: What the Package Does (One Line, Title Case)' -version: 0.0.0.9000 +title: 'bcsa: Data for source-apportionment of light absorbing carbon in Blantyre, + Malawi' +version: 0.0.1 +doi: 10.5281/zenodo.10878608 abstract: The bcsa package provide datasets for source apportionment of light absorbing carbon (LAC) in Blantyre, Malawi. The package contains data on Absorption Angstrom Exponent experiments determination of local pollution sources. The package also @@ -41,7 +43,7 @@ authors: given-names: Lars email: lschoebitz@ethz.ch orcid: https://orcid.org/0000-0003-2196-5015 -date-released: '2024-03-25' +date-released: '2024-03-26' contact: - family-names: Vijay given-names: Saloni diff --git a/DESCRIPTION b/DESCRIPTION index f2387a5..9af311e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: bcsa Title: Data for source-apportionment of light absorbing carbon in Blantyre, Malawi -Version: 0.0.0.9000 +Version: 0.0.1 Authors@R: c( person("Saloni", "Vijay", , "svijay@ethz.ch", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5883-5308")), diff --git a/README.Rmd b/README.Rmd index 367219c..1c21625 100644 --- a/README.Rmd +++ b/README.Rmd @@ -34,6 +34,7 @@ library(bcsa) [![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/) [![R-CMD-check](https://github.com/Global-Health-Engineering/bcsa/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Global-Health-Engineering/bcsa/actions/workflows/R-CMD-check.yaml) +[![DOI](https://zenodo.org/badge/686992598.svg)](https://zenodo.org/doi/10.5281/zenodo.10878607) diff --git a/README.md b/README.md index 248dbf7..22d68a1 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ [![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/) [![R-CMD-check](https://github.com/Global-Health-Engineering/bcsa/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Global-Health-Engineering/bcsa/actions/workflows/R-CMD-check.yaml) +[![DOI](https://zenodo.org/badge/686992598.svg)](https://zenodo.org/doi/10.5281/zenodo.10878607) The goal of `bcsa` is to provide datasets for source apportionment of @@ -125,7 +126,7 @@ df_aae |> gt::as_raw_html() ``` -
+
@@ -568,7 +569,7 @@ df_mm |> gt::as_raw_html() ``` -
+
@@ -1040,7 +1041,7 @@ df_mm_road_type |> gt::as_raw_html() ``` -
+
@@ -1556,7 +1557,7 @@ df_pm |> gt::as_raw_html() ``` -
+
@@ -2028,7 +2029,7 @@ df_pm_trips |> gt::as_raw_html() ``` -
+
@@ -2280,7 +2281,7 @@ df_sm |> gt::as_raw_html() ``` -
+
@@ -2715,7 +2716,7 @@ df_collocation |> gt::as_raw_html() ``` -
+
diff --git a/data-raw/package_processing.R b/data-raw/package_processing.R new file mode 100644 index 0000000..179ec23 --- /dev/null +++ b/data-raw/package_processing.R @@ -0,0 +1,30 @@ +# install.packages("cffr") +library(cffr) + +packageVersion("cffr") + +# Hard code doi +doi <- "10.5281/zenodo.10878608" + +# creates CFF with all author roles +mod_cff <- cff_create("DESCRIPTION", + dependencies = FALSE, + keys = list("doi" = doi, + "date-released" = Sys.Date())) + +# Remove the preferred-citation key +mod_cff$`preferred-citation` <- NULL + +# writes the CFF file +cff_write(mod_cff) + +# Now write a CITATION file from the CITATION.cff file +# Use inst/CITATION instead (the default if not provided) +path_cit <- file.path("inst/CITATION") + +a_cff <- cff_read(path = "CITATION.cff") + +cff_write_citation(a_cff, file = path_cit) + +# By last, read the citation +cat(readLines(path_cit), sep = "\n") diff --git a/docs/404.html b/docs/404.html index a111eaf..fb2fcde 100644 --- a/docs/404.html +++ b/docs/404.html @@ -24,7 +24,7 @@ bcsa - 0.0.0.9000 + 0.0.1
@@ -900,7 +903,7 @@

df_mm head() |> gt::gt() |> gt::as_raw_html() -
+

@@ -1686,7 +1689,7 @@

df_mm_road_type head() |> gt::gt() |> gt::as_raw_html() -
+

@@ -2538,7 +2541,7 @@

df_pm head() |> gt::gt() |> gt::as_raw_html() -
+

@@ -3324,7 +3327,7 @@

df_pm_tripshead() |> gt::gt() |> gt::as_raw_html() -
+

@@ -3726,7 +3729,7 @@

df_sm head() |> gt::gt() |> gt::as_raw_html() -
+

@@ -4448,7 +4451,7 @@

df_collocation head() |> gt::gt() |> gt::as_raw_html() -
+

@@ -5224,6 +5227,8 @@

Developers

Dev status

  • License: CC BY 4.0
    • +
  • R-CMD-check
    • +
  • DOI
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index ceb3b17..b29a88c 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.6 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2024-03-25T15:08Z +last_built: 2024-03-26T13:51Z urls: reference: https://global-health-engineering.github.io/durbanplasticwaste/reference article: https://global-health-engineering.github.io/durbanplasticwaste/articles diff --git a/docs/reference/df_aae.html b/docs/reference/df_aae.html index 6b3cc0b..ae1d1a9 100644 --- a/docs/reference/df_aae.html +++ b/docs/reference/df_aae.html @@ -16,7 +16,7 @@ bcsa - 0.0.0.9000 + 0.0.1