roxygen_assess_family: Helper for creating a roxygen header from template for...
In riskmetric: Risk Metrics to Evaluating R Packages

roxygen_assess_family

R Documentation

Helper for creating a roxygen header from template for assess_* functions

Description

Helper for creating a roxygen header from template for assess_* functions

Usage

roxygen_assess_family(
  name,
  return_type = "an atomic assessment result",
  dontrun = TRUE
)

Arguments

`name`	the name of the assessment, assuming naming conventions are followed
`return_type`	an optional added commentary about the return type of the assessment function
`dontrun`	logical indicating whether examples should be wrapped in a dontrun block. This is particularly useful for assessments which may require an internet connection.

Value

roxygen section template for assess family functions

Examples

## Not run: 
#' @eval roxygen_assess_family(
#'   "has_news",
#'   "an integer value indicating the number of discovered NEWS files")

## End(Not run)

riskmetric documentation built on May 29, 2024, 7:13 a.m.