roxygen_score_family: Helper for creating a roxygen header from template for...

View source: R/pkg_score.R

roxygen_score_familyR 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)

pharmaR/riskmetric documentation built on April 30, 2024, 5:14 p.m.