get_checks2: run rcmdcheck and BiocCheck on all sources associated with a...

View source: R/get_all.R

get_checks2R Documentation

run rcmdcheck and BiocCheck on all sources associated with a PackageSet and drop the RDS outputs in separate folders

Description

run rcmdcheck and BiocCheck on all sources associated with a PackageSet and drop the RDS outputs in separate folders

Usage

get_checks2(
  pkgset,
  sources.folder,
  checks.destination,
  bcchecks.destination,
  bcobj.destination,
  shuffle.pks = FALSE,
  BPPARAM = bpparam(),
  BPOPTIONS = bpoptions()
)

Arguments

pkgset

instance of PackageSet

sources.folder

path to git repos

checks.destination

path to folder holding RDS of rcmdcheck output

bcchecks.destination

character(1) path to a writeable folder where BiocCheck logs are written

bcobj.destination

character(1) path to a folder where RDS files with data frames are written

shuffle.pks

logical(1) if TRUE the packages are randomized before checking

BPPARAM

defaults to bpparam()

BPOPTIONS

defaults to bpoptions()

Note

returns NULL (if all artifacts are already present in destinations) or list of NULLs


vjcitn/BiocBuildTools documentation built on March 15, 2024, 4:19 a.m.