make.callgraph.roclet: Make a callgraph roclet which produces a static call graph...

Description Usage Arguments Details TODO

View source: R/callgraph.R

Description

Make a callgraph roclet which produces a static call graph from a given function at a given depth with or without primitives.

Usage

1
make.callgraph.roclet(dependencies, dir=".", verbose=TRUE)

Arguments

dependencies

packages required to evaluate interesting functions

dir

the directory to place the callgraphs in

verbose

anounce what we're doing

Details

The callgraph roclet supports the following tags:

  1. @callGraphCreate a call graph of the default depth, excluding primitive functions.

  2. @callGraphPrimitivesCreate a call graph of the default depth, including primitive functions.

  3. @callGraphDepthChange the depth of the callgraph from the default of 2.

The callgraph roclet is awkward in the sense that it requires a function's package to be loadable; which means, like calling LaTeX multiple times, one has to run roxygen on a package, install it, run roxygen again to get the callgraphs, and possibly install the package again.

TODO


roxygen documentation built on May 31, 2017, 1:55 a.m.