roxygen_score_family: Helper for creating a roxygen header from template for...
In riskmetric: Risk Metrics to Evaluating R Packages
roxygen_score_family 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)
riskmetric documentation built on April 4, 2025, 4:32 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| roxygen_score_family | 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)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.