sidekick: Builds a tree structure of an R source file

In SciViews/svTools: Wrappers for Tools in Other Packages for IDE Friendliness

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, ...)
## Default S3 method:
sidekick(x, ...)
## S3 method for class '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

Author(s)

Romain Francois <[e-mail]>

See Also

parse

Examples

## Not run: 
sidekick(outer)

## End(Not run)

SciViews/svTools documentation built on May 5, 2019, 12:29 p.m.