svTools (version 0.9-5)

sidekick: Builds a tree structure of an R source file

Description

The sidekick function builds a tree structure of an R code file by analysing output of the R parser.

Usage

sidekick(x, …)
# S3 method for character
sidekick(x, encoding = getOption("encoding"), delete.file = FALSE, …)
# S3 method for default
sidekick(x, …)
# S3 method for function
sidekick(x, …)

Arguments

x

a file to parse and analyse. If x is a function, it is first dumped into a file.

encoding

encoding to use. Default to the encoding option (see options).

delete.file

should the file be delete when the function exits?

…

further arguments to pass to the method.

Value

A Data frame with columns:

id

parent

srcref1

srcref2

srcref3

srcref4

description

See Also

parse

Examples

# NOT RUN {
sidekick(outer)
# }