sidekick {svTools}R Documentation

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, ... )
## 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 delete file
... ...

Value

A Data frame with columns:

id
parent
srcref1
srcref2
srcref3
srcref4
description

Author(s)

Romain Francois <francoisromain@free.fr>

See Also

parser

Examples

        ## Not run: sidekick( outer )

[Package svTools version 0.0-12 Index]