makeDepGraph: Create a graph representing R package dependencies

View source: R/makeDepGraph.R

makeDepGraphR Documentation

Create a graph representing R package dependencies

Description

Given a list of CRAN-style repository URLs, this function creates a graph instance representing dependencies between packages in the repositories.

Usage

makeDepGraph(repList, suggests.only = FALSE, type =
getOption("pkgType"), keep.builtin = FALSE, dosize = TRUE)

Arguments

repList

a character vector of URLs pointing to CRAN-style repositories.

suggests.only

logical value indicating whether only the "Suggests" field should be used. The default (FALSE) means that DESCRIPTION fields "Depends" and "Imports" are used. Note that "Suggests" is special in that its use is less regulated and the resulting graph is less likely to be a DAG (packages sometimes suggest each other).

type

a character vector specifying the type of packages to search for in the repositories. Must be one of "source", "win.binary", or "mac.binary".

keep.builtin

logical value indicating whether or not packages that come with a default R installation should be included in the nodes of the dependency graph. The default, FALSE, is to remove these packages from the return result.

dosize

logical value. When TRUE, the function will attempt to estimate the download size of each package (requires the RCurl package). The size of each package is added as a node attribute to the graph.

Value

A graphNEL-class instance. If the dosize argument was set to TRUE, then an estimate of the download size of each package is stored as a node attribute of the graph. A missing value is used when the download size was not able to be determined as well as when the RCurl package is not available.

Author(s)

Seth Falcon

Examples

  ## Not run: 
    deps <- makeDepGraph("http://cran.fhcrc.org", type="source")
  
## End(Not run)

Bioconductor/pkgDepTools documentation built on Nov. 19, 2022, 1:32 a.m.