get.function.dependencies: Determine all the dependencies of a function from a list of...

In drmjc/updateR: Package development toolkit

Description

For a given function, exhaustively determine which functions are in turn called by that function. This is designed to search within a subset of packages - perhaps ones that you are actively coding. This method will also tell you which CRAN or BioConductor packages are also referenced.

Usage

  get.function.dependencies(fun,
    packages = c(list.my.packages(src.root = getOption("src.root")), ".GlobalEnv"),
    verbose = FALSE)

Arguments

fun	either a function name, of the function's code
packages	vector of packages to search for dependencies in (ie packages that you probably wrote), Include .GlobalEnv if you want to trace inside functions which may be loaded in the workspace.
verbose	print the recursive dependency trace

Details

If you've ever wanted to give someone a single function from within a package full of code, then you've probably forgotten about some of the code that this function depends upon, which you wrote & which is not available on CRAN/BioC. Given a single function, this method will determine all the code dependencies, ie all the functions which will ever get called. This is exhaustive, in that it doesn't only look for functions inside conditional statements – all functions are returned. It only searches within a limited set of packages, such as those that you may have written yourself & not published yet. It will also tell you which CRAN/BioC packages need to be installed, but will ignore those packages which are automatically loaded at startup.

Value

A list with these elements:

my.functions	a character vector of all functions that are called, that are also in the my.packages packages
my.function.packages	a vector indicating which package each function came from
cran	a vector of CRAN packages that are referenced
bioc	a vector of BioConductor packages that are referenced
other.packages	a vector of other packages not from CRAN, or BioConductor, or my.packages

Author(s)

Mark Cowley

See Also

findGlobals, list.my.packages

Examples

options(src.root="~/src/R")
get.function.dependencies("updateR")
get.function.dependencies(updateR)

drmjc/updateR documentation built on May 15, 2019, 2:41 p.m.