pkgBiocRevDeps: Obtain all the reverse dependencies for a Bioconductor...

In seandavi/BiocPkgTools: Collection of simple tools for learning about Bioconductor Packages

Obtain all the reverse dependencies for a Bioconductor package

Description

The function returns a slightly upgraded list with dependency types as elements and package names in each of those elements, if any. The types of dependencies can be seen in the which argument documentation.

Usage

pkgBiocRevDeps(
  pkg,
  pkgType = c("software", "data-experiment", "workflows", "data-annotation"),
  which = "all",
  only.bioc = TRUE,
  version = BiocManager::version()
)

## S3 method for class 'biocrevdeps'
summary(object, ...)

Arguments

pkg	character(1) The package for which to look up dependencies.
pkgType	character() Any of 'software', 'data-experiment', 'workflows', and / or 'data-annotation' (defaults to all)
which	a character vector listing the types of dependencies, a subset of c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances"). Character string "all" is shorthand for that vector, character string "most" for the same vector without "Enhances", character string "strong" (default) for the first three elements of that vector.
only.bioc	logical(1) Whether to only return Bioconductor dependencies in the list (default TRUE)
version	(Optional) character(1) or package_version indicating the Bioconductor version (e.g., "3.8") for which repositories are required.
object	an object for which a summary is desired.
...	additional arguments affecting the summary produced.

Details

The summary method of the biocrevdeps class given by pkgBiocRevDeps provides a tally in each dependency field.

Value

A biocrevdeps list class object

Examples

rdeps <- pkgBiocRevDeps("MultiAssayExperiment", which = "all")
rdeps
summary(rdeps)

seandavi/BiocPkgTools documentation built on May 23, 2024, 1:53 p.m.