summary.multi_package_usage: Package Usage Summary

In ashbaldry/depcheck: Dependency Use Checker for R Packages

Description

Package Usage Summary

Usage

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

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
ignore_low_usage_packages	A vector of packages to ignore the low usage of, usually when already aware of the low usage, but the dependent package is necessary for the project.
...	Not used

Details

Package 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.

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