assess_has_examples: Assess a package for the presence of example or usage fields...

In pharmaR/riskmetric: Risk Metrics to Evaluating R Packages

Assess a package for the presence of example or usage fields in function documentation

Description

Assess a package for the presence of example or usage fields in function documentation

Usage

assess_has_examples(x, ...)

Arguments

x	a pkg_ref package reference object
...	additional arguments passed on to S3 methods, rarely used

Value

a pkg_metric containing an integer value indicating the proportion of discovered files with examples

See Also

metric_score.pkg_metric_has_examples

Examples

## Not run: 
assess_has_examples(pkg_ref("riskmetric"))

## End(Not run)

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