[Sciviews-commits] r121 - pkg/svTools/man

[noreply at r-forge.r-project.org]

Author: romain
Date: 2009-03-12 09:12:30 +0100 (Thu, 12 Mar 2009)
New Revision: 121

Added:
   pkg/svTools/man/sidekick.Rd
Log:
starting to document svTools

Added: pkg/svTools/man/sidekick.Rd
===================================================================
--- pkg/svTools/man/sidekick.Rd	                        (rev 0)
+++ pkg/svTools/man/sidekick.Rd	2009-03-12 08:12:30 UTC (rev 121)
@@ -0,0 +1,45 @@
+\name{sidekick}
+\Rdversion{1.1}
+\alias{sidekick}
+\title{
+	Builds a tree structure of an R source file
+}
+\description{
+	The \code{sidekick} function builds a tree structure of 
+	an R code file by analysing output of the R parser
+}
+\usage{
+sidekick(file, encoding = getOption("encoding"))
+}
+\arguments{
+  \item{file}{
+	  A file to \code{\link{parse}} and analyse. If \code{file}
+	  is a function, it is first dumped into a file.
+}
+  \item{encoding}{
+	  Encoding to use. Default to the encoding option (see \link{options})
+}
+}
+\value{
+A Data frame with columns:
+\item{id}{}
+\item{parent}{}
+\item{srcref1}{}
+\item{srcref2}{}
+\item{srcref3}{}
+\item{srcref4}{}
+\item{description}{}
+
+}
+\author{
+	Romain Francois <francoisromain at free.fr>
+}
+
+\seealso{
+	\code{\link{parse}}
+}
+\examples{
+	sidekick( outer )
+}
+\keyword{ manip }
+