Generate a QC report for a package — QCPackage • qcthat

A QC report combines information about GitHub issues associated with a package (see FetchRepoIssues()) and testthat test results for the package (see CompileTestResults()) using CompileIssueTestMatrix().

Usage

QCPackage(
  strPkgRoot = ".",
  strOwner = GetGHOwner(strPkgRoot),
  strRepo = GetGHRepo(strPkgRoot),
  strGHToken = gh::gh_token(),
  chrIgnoredLabels = DefaultIgnoreLabels(),
  envCall = rlang::caller_env()
)

Arguments

strPkgRoot: (length-1 character) The path to a directory in the package. Will be expanded using gert::git_find().
strOwner: (length-1 character) GitHub username or organization name.
strRepo: (length-1 character) GitHub repository name.
strGHToken: (length-1 character) GitHub token with permissions appropriate to the action being performed.
chrIgnoredLabels: (character) GitHub labels to ignore, such as "qcthat-nocov".
envCall: (environment) The environment to use for error reporting. Typically set to rlang::caller_env().

Value

A qcthat_IssueTestMatrix object as returned by CompileIssueTestMatrix().

Examples

if (FALSE) { # interactive()

  QCPackage()
}