Add getDependencyData()

NAMESPACE

@@ -16,6 +16,7 @@ export(equidistantAngles)
 export(exampleLinksAndNodes)
 export(getAuthors)
 export(getCranPackageDatabase)
+export(getDependencyData)
 export(getPackageFilesToInstall)
 export(getPackageLicences)
 export(getRVersionMajorMinor)
@@ -54,6 +55,7 @@ importFrom(kwb.utils,defaultIfNA)
 importFrom(kwb.utils,defaultIfNULL)
 importFrom(kwb.utils,excludeNULL)
 importFrom(kwb.utils,extractSubstring)
+importFrom(kwb.utils,fullySorted)
 importFrom(kwb.utils,getAttribute)
 importFrom(kwb.utils,get_homedir)
 importFrom(kwb.utils,hsRestoreAttributes)

NEWS.md

@@ -4,6 +4,7 @@ The following public functions were added:
 
 - getAuthors()
 - getCranPackageDatabase()
+- getDependencyData()
 - getPackageLicences()
 - hasGplLicence()
 - packageDependenciesByType()

R/getDependencyData.R

@@ -0,0 +1,72 @@
+# getDependencyData ------------------------------------------------------------
+
+#' Get Package Dependency Data from Package Database
+#' 
+#' @param db package data base as e.g. returned by
+#'   \code{\link{getCranPackageDatabase}}
+#' @param fields types of dependencies to be considered. Default:
+#'   \code{c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances")} 
+#' @export
+getDependencyData <- function(
+    db, 
+    fields = c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances")
+)
+{
+  stopifnot(`db must be a matrix or a data frame` = length(dim(db)) == 2L)
+
+  db <- as.data.frame(db)
+  packages <- selectColumns(db, "Package")
+
+  deps <- lapply(fields, function(field) {
+    catAndRun(
+      sprintf("Analysing %s field", field),
+      packages %>% 
+        toDependencyData(selectColumns(db, field)) %>% 
+        cbind(
+          type = tolower(field),
+          reverse = FALSE
+        )
+    )
+  }) %>% 
+    rbindAll() %>% 
+    fullySorted() %>% 
+    moveColumnsToFront(c("package", "type"))
+}
+
+# toDependencyData -------------------------------------------------------------
+toDependencyData <- function(packages, strings)
+{
+  stopifnot(length(packages) == length(strings))
+
+  # Split dependency strings at comma (after removing new line or space)
+  parts <- strsplit(gsub("\n|\\s+", "", strings), ",")
+
+  data.frame(
+    package = rep(packages, lengths(parts)),
+    splitDependency(unlist(parts))
+  )
+}
+
+# splitDependency --------------------------------------------------------------
+splitDependency <- function(x)
+{
+  stopifnot(`No spaces allowed!` = !any(grepl("\\s", x)))
+
+  pattern <- "^([^(]+)(\\(([<>=]+)(.*)\\))?"
+  matches <- is.na(x) | grepl(pattern, x)
+
+  if (any(!matches)) {
+    stopFormatted(
+      "Non-matching dependency string: '%s'", x[!matches][1L]
+    )
+  }
+
+  cbind(
+    dep_full = x, 
+    extractSubstring(pattern, x, index = c(
+      dep_name = 1L, 
+      dep_version_op = 3L, 
+      dep_version_no = 4L
+    ))
+  )
+}

R/utils.R

@@ -74,6 +74,10 @@ excludeNull <- kwb.utils::excludeNULL
 #' @importFrom kwb.utils extractSubstring
 extractSubstring <- kwb.utils::extractSubstring
 
+# fullySorted ------------------------------------------------------------------
+#' @importFrom kwb.utils fullySorted
+fullySorted <- kwb.utils::fullySorted
+
 # getAttribute -----------------------------------------------------------------
 #' @importFrom kwb.utils getAttribute
 getAttribute <- kwb.utils::getAttribute