[Sciviews-commits] r166 - in pkg/svTools: . man

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

Author: romain
Date: 2009-08-06 14:14:59 +0200 (Thu, 06 Aug 2009)
New Revision: 166

Added:
   pkg/svTools/man/descriptionFields.Rd
Modified:
   pkg/svTools/NAMESPACE
Log:
added some documentation

Modified: pkg/svTools/NAMESPACE
===================================================================
--- pkg/svTools/NAMESPACE	2009-08-06 12:08:27 UTC (rev 165)
+++ pkg/svTools/NAMESPACE	2009-08-06 12:14:59 UTC (rev 166)
@@ -8,10 +8,10 @@
 export( sidekick )
 
 # errorlist.R
-export( getErrors )
-export( addError )
-export( resetErrors )
-export( emptyError )
+# export( getErrors )
+# export( addError )
+# export( resetErrors )
+# export( emptyError )
 
 # parseError.R
 export( parseError )
@@ -49,10 +49,10 @@
 # rdparse.R
 export( rdparse )
 
-S3method( print, rsitesearch )
-S3method( head, rsitesearch )
-S3method( tail, rsitesearch )
-S3method( summary, rsitesearch )
-S3method( "[", rsitesearch )
+# S3method( print, rsitesearch )
+# S3method( head, rsitesearch )
+# S3method( tail, rsitesearch )
+# S3method( summary, rsitesearch )
+# S3method( "[", rsitesearch )
 
 

Added: pkg/svTools/man/descriptionFields.Rd
===================================================================
--- pkg/svTools/man/descriptionFields.Rd	                        (rev 0)
+++ pkg/svTools/man/descriptionFields.Rd	2009-08-06 12:14:59 UTC (rev 166)
@@ -0,0 +1,27 @@
+\name{descriptionFields}
+\Rdversion{1.1}
+\alias{descriptionFields}
+\docType{data}
+\title{
+List of possible fields in DESCRIPTION files
+}
+\description{
+List of possible fields in DESCRIPTION files and their meaning
+}
+\usage{data(descriptionFields)}
+\format{
+  A data frame with 19 observations on the following 3 variables.
+  \describe{
+    \item{\code{field}}{The name of the field as it should appear on the DESCRIPTION file}
+    \item{\code{optional}}{A factor with levels \code{Mandatory} \code{Optional}}
+    \item{\code{description}}{A description of each field}
+  }
+}
+\references{
+Writing R extensions
+}
+\examples{
+data(descriptionFields)
+}
+\keyword{datasets}
+