get_description {deepdep}

R Documentation

Scrap the DESCRIPTION file and CRAN metadata of the package

Description

This function uses api of CRAN Data Base to scrap the DESCRIPTION file and CRAN metadata of the package. It caches the results to speed the computation process.

Usage

get_description(package, bioc = FALSE, local = FALSE, reset_cache = FALSE)

Arguments

package	A character. Name of the package that is on CRAN, Bioconductor repository or locally installed. See bioc and local arguments.
bioc	A logical value. If TRUE the Bioconductor dependencies data will be taken from the Bioconductor repository. For this option to work properly, BiocManager package needs to be installed.
local	A logical value. If TRUE only data of locally installed packages will be used (without API usage).
reset_cache	A logical value. If TRUE the cache will be cleared before obtaining the list of packages.

Value

An object of package_description class.

Examples

library(deepdep)


description <- get_description("ggplot2")
description

description_local <- get_description("deepdep", local = TRUE)
description_local

---