make.callgraph.roclet {roxygen}R Documentation

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

Description

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

Usage

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:

    @callGraph
    Create a call graph of the default depth, excluding primitive functions.
    @callGraphPrimitives
    Create a call graph of the default depth, including primitive functions.
    @callGraphDepth
    Change 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


[Package roxygen version 0.1 Index]