trace_package {typetracer} | R Documentation |
Trace all parameters for all functions in a specified package
Description
Trace all parameters for all functions in a specified package
Usage
trace_package(
package = NULL,
pkg_dir = NULL,
functions = NULL,
types = c("examples", "tests"),
trace_lists = FALSE
)
Arguments
package |
Name of package to be traced (as character value). |
pkg_dir |
For "types" including "tests", a local directory to the source code of the package. (This is needed because installed versions do not generally include tests.) |
functions |
Optional character vector of names of functions to trace. Defaults to tracing all functions. |
types |
The types of code to be run to generate traces: one or both
values of "examples" or "tests" (as for |
trace_lists |
If |
Value
A data.frame
of data on every parameter of every function as
specified in code provided in package examples.
Examples
## Not run:
res <- trace_package ("rematch")
res <- trace_package (pkg_dir = "/<path>/<to>/<local>/<pacakge>")
## End(Not run)