get_description_repo: Get _DESCRIPTION_ files for R repos

In rworkflows: Test, Document, Containerise, and Deploy R Packages

Get DESCRIPTION files for R repos

Description

Get the DESCRIPTION file information in data.table format for all R packages in standard R repositories (CRAN, Bioc). Can return a subset of results for specific packages as well.

Usage

get_description_repo(
  refs = NULL,
  db = NULL,
  repo = c("BioCsoft", "BioCann", "BioCexp", "BioCworkflows", "CRAN"),
  version = BiocManager::version(),
  verbose = TRUE
)

Arguments

refs	Reference for one or more GitHub repository in owner/repo format (e.g."neurogenomics/rworkflows"), or an R package name (e.g. "rworkflows").
db	A data.table of R package metadata generated by biocPkgList.
repo	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?).
version	The requested Bioconductor version. Will default to use the BiocManager defaults (i.e., version()).
verbose	Print messages.

Value

Named list of desc objects.

rworkflows documentation built on Sept. 23, 2024, 1:08 a.m.