author2df() returns the role of the person

inbo · Aug 20, 2024 · 4cb0cb4 · 4cb0cb4
1 parent f3cd48e
commit 4cb0cb4
Show file tree

Hide file tree

Showing 18 changed files with 52 additions and 12 deletions.
diff --git a/R/store_authors.R b/R/store_authors.R
@@ -14,7 +14,7 @@ store_authors <- function(x = ".") {
     this_desc$get_authors() |>
       author2df() |>
       cbind(usage = 1) |>
-      rbind(current) -> new_author_df
+      rbind(cbind(current, role = "")) -> new_author_df
   } else {
     citation_meta$new(x)$get_meta$authors |>
       cbind(usage = 1, email = "") -> cit_meta
@@ -35,7 +35,13 @@ store_authors <- function(x = ".") {
 }
 
 #' Convert person object in a data.frame.
+#'
+#' Results in a data.frame with the given name, family name, e-mail, ORCID,
+#' affiliation and role.
+#' Missing elements result in an empty string (`""`).
+#' Persons with multiple roles will have the roles as a comma separated string.
 #' @param person The person object or a list of person objects, `NA` or `NULL`.
+#' @family utils
 #' @export
 author2df <- function(person) {
   UseMethod("author2df", person)
@@ -53,15 +59,15 @@ author2df.logical <- function(person) {
   )
   data.frame(
     given = character(0), family = character(0), email = character(0),
-    orcid = character(0), affiliation = character(0)
+    orcid = character(0), affiliation = character(0), role = character(0)
   )
 }
 
 #' @export
 author2df.NULL <- function(person) {
   data.frame(
     given = character(0), family = character(0), email = character(0),
-    orcid = character(0), affiliation = character(0)
+    orcid = character(0), affiliation = character(0), role = character(0)
   )
 }
 
@@ -93,23 +99,18 @@ author2df.person <- function(person) {
         do.call(what = rbind)
     )
   }
-  if (all(person$role %in% c("cph", "fnd"))) {
-    return(data.frame(
-      given = character(0), family = character(0), email = character(0),
-      orcid = character(0), affiliation = character(0)
-    ))
-  }
 
   data.frame(
-    given = person$given, family = person$family,
+    given = coalesce(person$given, ""), family = coalesce(person$family, ""),
     email = coalesce(person$email, ""),
     orcid = ifelse(
       has_name(person$comment, "ORCID"), unname(person$comment["ORCID"]), ""
     ),
     affiliation = ifelse(
       has_name(person$comment, "affiliation"),
       unname(person$comment["affiliation"]), ""
-    )
+    ),
+    role = paste(person$role, collapse = ", ")
   )
 }
 

diff --git a/man/ask_yes_no.Rd b/man/ask_yes_no.Rd
diff --git a/man/author2df.Rd b/man/author2df.Rd
diff --git a/man/bookdown_zenodo.Rd b/man/bookdown_zenodo.Rd
diff --git a/man/c_sort.Rd b/man/c_sort.Rd
diff --git a/man/clean_git.Rd b/man/clean_git.Rd
diff --git a/man/create_hexsticker.Rd b/man/create_hexsticker.Rd
diff --git a/man/defunct.Rd b/man/defunct.Rd
diff --git a/man/execshell.Rd b/man/execshell.Rd
diff --git a/man/is_repository.Rd b/man/is_repository.Rd
diff --git a/man/is_workdir_clean.Rd b/man/is_workdir_clean.Rd
diff --git a/man/menu_first.Rd b/man/menu_first.Rd
diff --git a/man/new_branch.Rd b/man/new_branch.Rd
diff --git a/man/store_authors.Rd b/man/store_authors.Rd
diff --git a/man/use_author.Rd b/man/use_author.Rd
diff --git a/man/validate_email.Rd b/man/validate_email.Rd
diff --git a/man/validate_orcid.Rd b/man/validate_orcid.Rd
diff --git a/man/yesno.Rd b/man/yesno.Rd