Get environment dependency object

This function creates an object of class pkgdepR, representing the network of function calls between one or more packages.

Usage

deps(pkg, exported_only = FALSE)

Arguments

pkg

A character vector of the environments to explore. Should be on the search path. Cannot be base.

exported_only

Boolean. Whether to include non-exported functions.

Value

An object of class pkgdepR.

Details

An object of class pkgdepR is a list with three named objects:

funs

a data frame describing the functions. Contains columns id, label, package, exported, group, and name.

links

a data frame containing the linkages between functions. Contains columns from and to.

pkg

a character vector containing the packages explored.

Examples

library(pkgdepR)
deps(pkg = "pkgdepR")
#> 
#> pkgdepR object
#> ------------------------------
#> Packages:    pkgdepR
#> Total nodes: 16
#> Total links: 17
#>   -Between packages: 0
#>   -Within packages:  17
#>     --Between functions: 16
#>     --Self-referential:  1
#>