[Sciviews-commits] r34 - pkg/svMisc/man

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

Author: romain
Date: 2008-07-01 16:21:45 +0200 (Tue, 01 Jul 2008)
New Revision: 34

Added:
   pkg/svMisc/man/CompletePlus.Rd
Log:
added documentation for CompletePlus

Added: pkg/svMisc/man/CompletePlus.Rd
===================================================================
--- pkg/svMisc/man/CompletePlus.Rd	                        (rev 0)
+++ pkg/svMisc/man/CompletePlus.Rd	2008-07-01 14:21:45 UTC (rev 34)
@@ -0,0 +1,36 @@
+\name{CompletePlus}
+\alias{CompletePlus}
+\title{ Get completion and additional information from an R code fragment }
+\description{
+  The function generates completion possibilities and investigate
+  within the R help file to gather information about each completion.
+}
+\usage{
+CompletePlus(linebuffer, cursorPosition = nchar(linebuffer), minlength = 2, simplify = FALSE)
+}
+\arguments{
+  \item{linebuffer}{ R code fragment }
+  \item{cursorPosition}{ Position of the cursor in the fragment }
+  \item{minlength}{ Minimum size the fragment needs to be to perform the completion }
+  \item{simplify}{ Logical. If TRUE, then the result is printed using a simpler syntax rather. }
+}
+\details{
+  The information given back depends on the kind of completion performed. If a potential completion ends
+  with the equal sign, then \code{CompletePlus} tries to get information on the
+  argument from the guessed function. If the potential completion ends with \code{::}, then the
+  \code{CompletePlus} gets information about the package. If the potential completion is a function,
+  then \code{CompletePlus} retrieves the title of the function as documented in its Rd file if
+  the function is documented.
+}
+\value{
+  Either a matrix giving completion information. If simplify is set to TRUE, nothing is returned
+  but the result is \code{cat} directly to the console.
+}
+\author{ Romain Francois <rfrancois at mango-solutions.com> }
+\seealso{ \code{\link{Complete}} }
+\examples{
+  CompletePlus( "dn" )
+  CompletePlus( "rnorm( 10, me" )
+}
+\keyword{ utilities }
+