[R-gregmisc-users] SF.net SVN: r-gregmisc:[1389] trunk/gdata

[<ggr...@us...>]

Revision: 1389
          http://r-gregmisc.svn.sourceforge.net/r-gregmisc/?rev=1389&view=rev
Author:   ggrothendieck2
Date:     2010-01-24 02:28:11 +0000 (Sun, 24 Jan 2010)

Log Message:
-----------
added sheetNames.Rd (documenting sheetNames/sheetCount) and updated NAMESPACE file.

Modified Paths:
--------------
    trunk/gdata/NAMESPACE

Added Paths:
-----------
    trunk/gdata/man/sheetNames.Rd

Modified: trunk/gdata/NAMESPACE
===================================================================
--- trunk/gdata/NAMESPACE	2010-01-24 02:05:51 UTC (rev 1388)
+++ trunk/gdata/NAMESPACE	2010-01-24 02:28:11 UTC (rev 1389)
@@ -24,6 +24,8 @@
        remove.vars,
        reorder.factor,
        resample,
+       sheetCount,
+       sheetNames,
        trim,
        trimSum,
        unmatrix,

Added: trunk/gdata/man/sheetNames.Rd
===================================================================
--- trunk/gdata/man/sheetNames.Rd	                        (rev 0)
+++ trunk/gdata/man/sheetNames.Rd	2010-01-24 02:28:11 UTC (rev 1389)
@@ -0,0 +1,42 @@
+\name{sheetNames}
+\Rdversion{1.1}
+\alias{sheetCount}
+\alias{sheetNames}
+\title{
+Count sheets in Excel xls spreadsheet.
+}
+\description{
+Count the sheets in an Excel xls spreadsheet.
+}
+\usage{
+sheetCount(xls, verbose = FALSE, perl = "perl")
+sheetNames(xls, verbose = FALSE, perl = "perl")
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+  \item{xls}{
+File path to spreadsheet.  Is downloaded if it begins with \code{"http://"}.}
+  \item{verbose}{
+ If \code{TRUE} additional information displayed.
+}
+  \item{perl}{
+	Path and file of perl interpreter or just \code{"perl"} if perl on path.
+}
+}
+\value{
+\code{sheetCount} returns the number of sheets in the spreadsheet 
+and \code{sheetNames} returns
+a character vector containing the sheet names in the spreadsheet.
+}
+
+\seealso{
+	\code{\link{read.xls}}, \code{\link{xls2csv}}.
+}
+\examples{
+   xlsfile <- system.file("xls", "iris.xls", package = "gdata")
+   xlsfile
+
+   sheetCount(xlsfile)
+
+}
+\keyword{ misc }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.