roxygen_score_family {riskmetric} | R Documentation |
Helper for creating a roxygen header from template for score.* functions
Description
Helper for creating a roxygen header from template for score.* functions
Usage
roxygen_score_family(name, dontrun = TRUE)
Arguments
name |
the name of the scoring function, assuming naming conventions are followed |
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 score family functions
Examples
## Not run:
#' @eval roxygen_score_family("has_news")
## End(Not run)
[Package riskmetric version 0.2.4 Index]