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

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

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

Added:
   pkg/svTools/man/check_description.Rd
Log:
added some documentation

Added: pkg/svTools/man/check_description.Rd
===================================================================
--- pkg/svTools/man/check_description.Rd	                        (rev 0)
+++ pkg/svTools/man/check_description.Rd	2009-08-06 12:08:27 UTC (rev 165)
@@ -0,0 +1,24 @@
+\name{check_description}
+\Rdversion{1.1}
+\alias{check_description}
+\title{checks on DESCRIPTION files}
+\description{
+This performs various checks on the DESCRIPTION files
+}
+\usage{
+check_description(descfile, txt = readLines(descfile))
+}
+\arguments{
+  \item{descfile}{the name of the file}
+  \item{txt}{the content of the file}
+}
+\value{
+A data frame with potential problems
+}
+\author{
+Romain Francois <francoisromain at free.fr>
+}
+\seealso{
+\code{\link{completeDescription}} to complete a DESCRIPTION file
+}
+\keyword{manip}