Learn R Programming

svTools (version 0.9-0)

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 class 'character':
sidekick(x, encoding = getOption("encoding"), delete.file = FALSE, ...)
## S3 method for class 'default':
sidekick(x, \dots)
## S3 method for class 'function':
sidekick(x, \dots)

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

concept

code parsing and analysis

See Also

parse

Examples

Run this code
sidekick(outer)

Run the code above in your browser using DataLab