summary.package_usage: Function Usage Summary

In ashbaldry/depcheck: Dependency Use Checker for R Packages

Description

Function Usage Summary

Usage

## S3 method for class 'package_usage'
summary(object, warn_percent_usage = 0.2, warn_number_usage = 3, ...)

Arguments

object	A package_usage data.frame
warn_percent_usage	Minimum percent of functions to be used within a dependent package. Default is 20%
warn_number_usage	Minimum number of functions to be used within a dependent package. Default is 3
...	Not used

Details

Function usage must be below both thresholds for the warning to appear. With the defaults, if a package has fewer than 5 functions then only 1 function is required to prevent a warning message to appear.

Examples

## Not run: 
package_use <- checkPackageUsage()
dependency_use <- checkPackageDependencyUse()
summary(dependency_use)

## End(Not run)

ashbaldry/depcheck documentation built on Jan. 1, 2022, 11:11 p.m.