The Liam Neeson of DESCRIPTION file functions.
I will look for you,
I will find you,
—and I will import you into a neatly parsed R object.
Uses a variety of alternative methods, including searching locally and on GitHub (whenever possible). Prioritises the fastest methods that do not involve downloading files first.
get_description(
refs = NULL,
paths = here::here("DESCRIPTION"),
db = NULL,
cache_dir = tools::R_user_dir(package = "rworkflows", which = "cache"),
force_new = FALSE,
use_wd = TRUE,
use_repos = FALSE,
repo = c("BioCsoft", "BioCann", "BioCexp", "BioCworkflows", "CRAN"),
verbose = TRUE
)Reference for one or more GitHub repository in owner/repo format
(e.g."neurogenomics/rworkflows"), or an R package name
(e.g. "rworkflows").
Paths to DESCRIPTION file(s) R package(s).
A data.table of R package metadata generated by biocPkgList.
Directory where to cache downloaded files.
Ignore cached files and re-download them instead.
Search the local working directory (and the one above it) for DESCRIPTION files.
Use R standard R package repositories like CRAN and Bioc to find DESCRIPTION files.
The requested Bioconductor repository. The default will be the Bioconductor software repository: BioCsoft. Available repos include: "BioCsoft", "BioCann", "BioCexp", "BioCworkflows", and "CRAN". Note that not all repos are available for all versions, particularly older versions (but who would use those, right?).
Print messages.
A named list of packageDescription objects.
d <- get_description(refs="neurogenomics/rworkflows")