Improve linting

R/cff_create.R

@@ -124,6 +124,48 @@ cff_create <- function(x, keys = list(), cff_version = "1.2.0",
     cli::cli_abort(msg)
   }
 
+  # Detect sources and build cff
+  result_parsed <- detect_sources(
+    x, cff_version, gh_keywords,
+    dependencies, authors_roles
+  )
+
+  desc_path <- result_parsed[["desc_path"]]
+  instpack <- result_parsed[["instpack"]]
+  cffobjend <- result_parsed[["cffobjend"]]
+
+
+
+  # Add software dependencies
+  if (dependencies) {
+    deps <- parse_dependencies(desc_path, instpack)
+
+    cffobjend$references <- unique(c(cffobjend$references, deps))
+  }
+
+  # Additional keys
+  if (!is.null(keys)) {
+    keys <- fuzzy_keys(keys)
+    cffobjendmod <- cffobjend[setdiff(names(cffobjend), names(keys))]
+    cffobjend <- modifyList(cffobjendmod, keys, keep.null = FALSE)
+    cffobjend <- as.cff(cffobjend)
+  }
+
+
+  # Order
+  cffobjend <- cffobjend[cff_schema_keys()]
+
+  # Enhance authors info
+  if (!is.null(cffobjend$`preferred-citation`)) {
+    cffobjend$`preferred-citation`$authors <- enhance_pref_authors(cffobjend)
+  }
+  cffobjend <- as.cff(cffobjend)
+  cffobjend
+}
+
+detect_sources <- function(x, cff_version = "1.2.0",
+                           gh_keywords = TRUE, dependencies = TRUE,
+                           authors_roles = c("aut", "cre")) {
   instpack <- as.character(installed.packages()[, "Package"])
 
   # Set initially citobj to NULL
@@ -183,29 +225,11 @@ cff_create <- function(x, keys = list(), cff_version = "1.2.0",
 
   cffobjend <- merge_desc_cit(cffobj, citobj)
 
-  # Add software dependencies
-  if (dependencies) {
-    deps <- parse_dependencies(desc_path, instpack)
-
-    cffobjend$references <- unique(c(cffobjend$references, deps))
-  }
+  # Return collected info
 
-  # Additional keys
-  if (!is.null(keys)) {
-    keys <- fuzzy_keys(keys)
-    cffobjendmod <- cffobjend[setdiff(names(cffobjend), names(keys))]
-    cffobjend <- modifyList(cffobjendmod, keys, keep.null = FALSE)
-    cffobjend <- as.cff(cffobjend)
-  }
-
-
-  # Order
-  cffobjend <- cffobjend[cff_schema_keys()]
-
-  # Enhance authors info
-  if (!is.null(cffobjend$`preferred-citation`)) {
-    cffobjend$`preferred-citation`$authors <- enhance_pref_authors(cffobjend)
-  }
-  cffobjend <- as.cff(cffobjend)
-  cffobjend
+  list(
+    desc_path = desc_path,
+    instpack = instpack,
+    cffobjend = cffobjend
+  )
 }

R/cff_gha_update.R

@@ -2,13 +2,14 @@
 #'
 #' @description
 #'
-#' This function would install a GitHub Action on your repo. The action
+#' This function would install a
+#' [GitHub Action](https://github.com/features/actions) on your repo. The action
 #' will update your `CITATION.cff` when any of these events occur:
 #' - You publish a new release of the package.
 #' - Your `DESCRIPTION` or `inst/CITATION` are modified.
 #' - The action can be run also manually.
 #'
-#' @param path Project directory
+#' @param path Project directory.
 #' @param overwrite Logical. If already present, do you want to overwrite your
 #'   action?
 #'
@@ -17,8 +18,13 @@
 #' @details
 #'
 #' Triggers on your action can be modified, see
-#' [Events that trigger
-#' workflows](https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows).
+#' ```{r, echo=FALSE, results='asis'}
+#'
+#' cat(paste0(" [Events that trigger workflows]",
+#'            "(https://docs.github.com/en/actions/learn-github-actions/",
+#'            "events-that-trigger-workflows)."))
+#'
+#' ```
 #'
 #' @examples
 #' \dontrun{

R/cff_git_hook.R

@@ -2,8 +2,15 @@
 #'
 #' @description
 #'
-#' Install a [pre-commit
-#' hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks#_committing_workflow_hooks)
+#' Install a
+#'
+#' ```{r, echo=FALSE, results='asis'}
+#'
+#' cat(paste0(" [pre-commit hook]",
+#'            "(https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks",
+#'            "#_committing_workflow_hooks) "))
+#'
+#' ```
 #' that remembers you to update your `CITATION.cff` file.
 #'
 #' @name cff_git_hook
@@ -26,7 +33,7 @@
 #' following conditions are met:
 #' - You included in a commit your `DESCRIPTION` or `inst/CITATION` file, you
 #'   are not including your `CITATION.cff` and the `CITATION.cff` file is
-#'   "older" than any of your `DESCRIPTION` or `inst/CITATION` file, or
+#'   "older" than any of your `DESCRIPTION` or `inst/CITATION` file.
 #' - You have updated your `CITATION.cff` but you are not including it on
 #'   your commit.
 #'

R/cff_read.R

@@ -81,14 +81,18 @@
 #' head(from_cff_file, 7)
 #'
 #' # Create cff object from DESCRIPTION
-#' from_desc <- cff_read(system.file("examples/DESCRIPTION_basic", package = "cffr"))
+#' from_desc <- cff_read(system.file("examples/DESCRIPTION_basic",
+#'   package = "cffr"
+#' ))
 #'
 #' from_desc
 #'
 #' # Create cff object from BibTex
 #'
 #' if (requireNamespace("bibtex", quietly = TRUE)) {
-#'   from_bib <- cff_read(system.file("examples/example.bib", package = "cffr"))
+#'   from_bib <- cff_read(system.file("examples/example.bib",
+#'     package = "cffr"
+#'   ))
 #'
 #'   # First item only
 #'   from_bib[[1]]