R/combine_deps.R

In dockr: Creation of Lightweight Docker Images for Your Packages

#' Combine Identified Dependencies with CRAN and Local Source Packages
#'
#' @param pkg_deps \code{data.frame} all package dependencies with package name
#' and version number.
#' @param deps_cran \code{data.frame} package dependencies matched with
#' CRAN.
#' @param deps_local \code{data.frame} package dependencies matched with
#' local source packages.
#' @inheritParams prepare_docker_image
#'
#' @return \code{list} prioritized dependencies split into CRAN dependencies
#' and dependencies of local source packages.
combine_deps <- function(pkg_deps, deps_cran, deps_local, prioritize_cran = FALSE) {
  
  # handle case, when there are no dependencies.
  if (is.null(pkg_deps) || nrow(pkg_deps) == 0) {
    return(NULL)
  }

  # which packages are matched?
  pkg_match <- c(deps_cran$pkg, deps_local$pkg)
  # which packages were not matched?
  pkg_no_match <- pkg_deps[!pkg_deps$pkg %in% pkg_match, c("pkg", "vrs"), drop = FALSE]
  # handle case, when one or more packages were not found.
  if (nrow(pkg_no_match) > 0) {
    stop("The following dependency packages were not found on CRAN nor in local directories: \n",
         paste(pkg_no_match$pkg, pkg_no_match$vrs, sep = "_", collapse = ", "))
  }

  # identify any overlap of packages between CRAN and local directories.
  pkg_overlap <- deps_cran[deps_cran$pkg %in% deps_local$pkg, c("pkg", "vrs"), drop = FALSE]
  if (!is.null(pkg_overlap) && nrow(pkg_overlap) != 0) {
    message("The following dependency packages were found both on CRAN and in local directories: \n",
            paste(pkg_overlap$pkg, pkg_overlap$vrs, sep = "_", collapse = ", "))
    if (prioritize_cran) {
      message("CRAN packages will be prioritized (change this choice with argument 'prioritize_cran').")
      # remove redundant dependencies from local dependencies.
      deps_local <- deps_local[!deps_local$pkg %in% pkg_overlap$pkg, , drop = FALSE]
    } else {
      message("Local source packages will be prioritized (change this choice with argument 'prioritize_cran').")
      # remove redundant dependencies from local dependencies.
      deps_cran <- deps_cran[!deps_cran$pkg %in% pkg_overlap$pkg, , drop = FALSE]
    }
  }

  # return as list with elements for CRAN and non-CRAN dependencies respectively.
  list(deps_cran = deps_cran, deps_local = deps_local)

}