added generate_citation()

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: robis
 Title: Ocean Biodiversity Information System (OBIS) Client
 Description: Client for the Ocean Biodiversity Information System (<https://obis.org>).
-Version: 2.10.1
-Date: 2022-01-26
+Version: 2.11.0
+Date: 2022-08-06
 Authors@R: c(
     person("Pieter", "Provoost", , "[email protected]", c("cre", "aut")),
     person("Samuel", "Bosch", , "[email protected]", role = "aut"),
@@ -30,7 +30,8 @@ Imports:
     curl,
     data.table,
     tidyselect,
-    xml2
+    xml2,
+    glue
 Collate:
     robis.R
     util.R

NAMESPACE

@@ -4,6 +4,7 @@ export(area)
 export(checklist)
 export(dataset)
 export(dna_records)
+export(generate_citation)
 export(get_geometry)
 export(map_ggplot)
 export(map_leaflet)
@@ -14,6 +15,7 @@ export(taxon)
 export(unnest_extension)
 import(dplyr)
 import(ggplot2)
+import(glue)
 import(httr)
 import(jsonlite)
 import(leaflet)

NEWS.md

@@ -1,3 +1,7 @@
+# rovis 2.11.0
+
+Added `generate_citation()`.
+
 # robis 2.10.1
 
 Added contacts to `dataset()`.

R/robis.R

@@ -8,7 +8,7 @@
 #'
 #' @docType package
 #' @name robis
-#' @import dplyr jsonlite leaflet ggplot2 tidyr tibble httr mapedit sf stringr tidyselect xml2
+#' @import dplyr jsonlite leaflet ggplot2 tidyr tibble httr mapedit sf stringr tidyselect xml2 glue
 #' @importFrom rlang .data
 #' @importFrom curl has_internet
 #' @importFrom data.table as.data.table

R/util.R

@@ -172,3 +172,29 @@ unnest_extension <- function(df, extension, fields = "id") {
     }
   }
 }
+
+#' Generate a citation from metadata elements.
+#'
+#' @usage generate_citation(title, published, url, contacts)
+#' @param title the dataset title.
+#' @param published the dataset published date.
+#' @param url the dataset url.
+#' @param contacts the dataset contacts as a dataframe.
+#' @return A citation string.
+#' @export
+generate_citation <- function(title, published, url, contacts) {
+  title <- gsub("\\.$", "", title)
+  published <- substr(published, 1, 10)
+  url <- url
+  names_list <- contacts %>%
+    select(givenname, surname, organization) %>%
+    distinct() %>%
+    arrange(surname) %>%
+    mutate(givenname = ifelse(!is.na(givenname), paste0(substr(givenname, 1, 1), "."), NA)) %>%
+    rowwise() %>%
+    mutate(name = ifelse(is.na(surname), organization, paste0(na.omit(c(surname, givenname)), collapse = ", "))) %>%
+    pull(name) %>%
+    paste0(collapse = ", ")
+  names_list <- gsub("\\.$", "", names_list)
+  glue("{names_list}. {title}. Published {published}. {url}.")
+}