checkPackageDependencyUse: Check Package Dependencies

In ashbaldry/depcheck: Dependency Use Checker for R Packages

Description

'checkPackageDependencyUse()' checks the DESCRIPTION file for packages mentioned in the Depends and Imports fields.

Using these packages, it then checks the scripts in the R directory to check for function use of each package.

Usage

checkPackageDependencyUse(path = ".", include_suggests = FALSE, verbose = TRUE)

Arguments

path	Path to the package root directory.
include_suggests	Logical, should the "Suggests" field also be checked for package dependencies or just the Depends and Imports?
verbose	Logical, should informative messages be printed during the dependency evaluation?

Value

An object of class multi_package_usage, a named list of the dependencies used, each containing a data.frame of all the functions within the package and how often they are used within the project.

The result will flag any packages that have been rarely used in the project.

See Also

checkProjectDependencyUse, checkShinyDependencyUse

Examples

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

## End(Not run)

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