Thread: [R-gregmisc-users] SF.net SVN: r-gregmisc:[1357] trunk/gdata/man
Brought to you by:
warnes
Menu
▾
▴
r-gregmisc-users
|
From: <wa...@us...> - 2009-08-20 14:54:58
|
Revision: 1357
http://r-gregmisc.svn.sourceforge.net/r-gregmisc/?rev=1357&view=rev
Author: warnes
Date: 2009-08-20 14:54:44 +0000 (Thu, 20 Aug 2009)
Log Message:
-----------
Replace \ldots with \dots to make the new R CMD CHECK happy.
Modified Paths:
--------------
trunk/gdata/man/cbindX.Rd
trunk/gdata/man/getDateTimePart.Rd
trunk/gdata/man/mapLevels.Rd
trunk/gdata/man/nPairs.Rd
trunk/gdata/man/trim.Rd
trunk/gdata/man/trimSum.Rd
trunk/gdata/man/unknown.Rd
trunk/gdata/man/write.fwf.Rd
Modified: trunk/gdata/man/cbindX.Rd
===================================================================
--- trunk/gdata/man/cbindX.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/cbindX.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -18,7 +18,7 @@
\usage{cbindX(...)}
\arguments{
- \item{\ldots}{matrix and data.frame objects}
+ \item{\dots}{matrix and data.frame objects}
}
\details{
Modified: trunk/gdata/man/getDateTimePart.Rd
===================================================================
--- trunk/gdata/man/getDateTimePart.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/getDateTimePart.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -44,12 +44,12 @@
\usage{
-getYear(x, format, \ldots)
-getMonth(x, format, \ldots)
-getDay(x, format, \ldots)
-getHour(x, format, \ldots)
-getMin(x, format, \ldots)
-getSec(x, format, \ldots)
+getYear(x, format, \dots)
+getMonth(x, format, \dots)
+getDay(x, format, \dots)
+getHour(x, format, \dots)
+getMin(x, format, \dots)
+getSec(x, format, \dots)
}
@@ -57,7 +57,7 @@
\arguments{
\item{x}{generic, date/time object}
\item{format}{character, format}
- \item{\ldots}{arguments pased to other methods}
+ \item{\dots}{arguments pased to other methods}
}
\value{Character}
Modified: trunk/gdata/man/mapLevels.Rd
===================================================================
--- trunk/gdata/man/mapLevels.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/mapLevels.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -56,7 +56,7 @@
\usage{
-mapLevels(x, codes=TRUE, sort=TRUE, drop=FALSE, combine=FALSE, \ldots)
+mapLevels(x, codes=TRUE, sort=TRUE, drop=FALSE, combine=FALSE, \dots)
mapLevels(x) <- value
}
@@ -69,7 +69,7 @@
details}
\item{drop}{boolean, drop unused levels}
\item{combine}{boolean, combine levels, look into details}
- \item{\ldots}{additional arguments for \code{sort}}
+ \item{\dots}{additional arguments for \code{sort}}
\item{value}{levelsMap or listLevelsMap, output of \code{mapLevels}
methods or constructed by user, look into details}
}
Modified: trunk/gdata/man/nPairs.Rd
===================================================================
--- trunk/gdata/man/nPairs.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/nPairs.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -28,7 +28,7 @@
\item{margin}{logical, calculate the cumulative number of \dQuote{pairs}}
\item{names}{logical, add row/col-names to the output}
\item{abbrev}{logical, abbreviate names}
- \item{\ldots}{other arguments passed to \code{\link{abbreviate}}}
+ \item{\dots}{other arguments passed to \code{\link{abbreviate}}}
}
\value{
Modified: trunk/gdata/man/trim.Rd
===================================================================
--- trunk/gdata/man/trim.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/trim.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -6,12 +6,12 @@
related objects.
}
\usage{
-trim(s, recode.factor=TRUE, \ldots)
+trim(s, recode.factor=TRUE, \dots)
}
\arguments{
\item{s}{object to be processed}
\item{recode.factor}{should levels of a factor be recoded, see below}
- \item{\ldots}{arguments passed to other methods, currently only to
+ \item{\dots}{arguments passed to other methods, currently only to
\code{\link{reorder.factor}} for factors}
}
Modified: trunk/gdata/man/trimSum.Rd
===================================================================
--- trunk/gdata/man/trimSum.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/trimSum.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -17,14 +17,14 @@
to specify the desired length of a trimmed vector.
}
-\usage{trimSum(x, n, right=TRUE, na.rm=FALSE, \ldots)}
+\usage{trimSum(x, n, right=TRUE, na.rm=FALSE, \dots)}
\arguments{
\item{x}{numeric, a vector of numeric values}
\item{n}{numeric, desired length of the output}
\item{right}{logical, trim on the right/bottom or the left/top side}
\item{na.rm}{logical, remove \code{NA} values when applying a function}
- \item{\ldots}{arguments passed to other methods - currently not used}
+ \item{\dots}{arguments passed to other methods - currently not used}
}
\value{Trimmed vector with a last/first value representing the sum of
Modified: trunk/gdata/man/unknown.Rd
===================================================================
--- trunk/gdata/man/unknown.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/unknown.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -41,9 +41,9 @@
\usage{
-isUnknown(x, unknown=NA, \ldots)
-unknownToNA(x, unknown, warning=FALSE, \ldots)
-NAToUnknown(x, unknown, force=FALSE, call.=FALSE, \ldots)
+isUnknown(x, unknown=NA, \dots)
+unknownToNA(x, unknown, warning=FALSE, \dots)
+NAToUnknown(x, unknown, force=FALSE, call.=FALSE, \dots)
}
@@ -52,7 +52,7 @@
\item{unknown}{generic, value used instead of \code{NA}}
\item{warning}{logical, issue warning if \code{x} already has \code{NA}}
\item{force}{logical, force to apply already existing value in \code{x}}
- \item{\ldots}{arguments pased to other methods (as.character for POSIXlt
+ \item{\dots}{arguments pased to other methods (as.character for POSIXlt
in case of isUnknown)}
\item{call.}{logical, look in \code{\link{warning}}}
}
Modified: trunk/gdata/man/write.fwf.Rd
===================================================================
--- trunk/gdata/man/write.fwf.Rd 2009-08-19 17:54:38 UTC (rev 1356)
+++ trunk/gdata/man/write.fwf.Rd 2009-08-20 14:54:44 UTC (rev 1357)
@@ -22,7 +22,7 @@
write.fwf(x, file="", append=FALSE, quote=FALSE, sep=" ", na="",
rownames=FALSE, colnames=TRUE, rowCol=NULL, justify="left",
- formatInfo=FALSE, quoteInfo=TRUE, width=NULL, \ldots)
+ formatInfo=FALSE, quoteInfo=TRUE, width=NULL, \dots)
}
@@ -44,7 +44,7 @@
widths and format}
\item{quoteInfo}{logical, should \code{formatInfo} account for quotes}
\item{width}{numeric, width of the columns in the output}
- \item{\ldots}{further arguments to \code{\link{format.info}},
+ \item{\dots}{further arguments to \code{\link{format.info}},
\code{\link{format}} and \code{\link{write.table}}}
}
@@ -59,11 +59,11 @@
done completely by \code{\link{format}} on a column basis. Columns in
the output are by default separated with a space i.e. empty column with
a width of one character, but that can be changed with \code{sep}
-argument as passed to \code{\link{write.table}} via \ldots.
+argument as passed to \code{\link{write.table}} via \dots.
As mentioned formatting is done completely by
\code{\link{format}}. Arguments can be passed to \code{format} via
-\code{\ldots} to further modify the output. However, note that the
+\code{\dots} to further modify the output. However, note that the
returned \code{formatInfo} might not properly account for this, since
\code{\link{format.info}} (which is used to collect information about
formatting) lacks the arguments of \code{\link{format}}.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <wa...@us...> - 2010-01-24 08:15:17
|
Revision: 1395
http://r-gregmisc.svn.sourceforge.net/r-gregmisc/?rev=1395&view=rev
Author: warnes
Date: 2010-01-24 08:15:10 +0000 (Sun, 24 Jan 2010)
Log Message:
-----------
Add/Update documentation
Modified Paths:
--------------
trunk/gdata/man/read.xls.Rd
Added Paths:
-----------
trunk/gdata/man/sheetCount.Rd
Modified: trunk/gdata/man/read.xls.Rd
===================================================================
--- trunk/gdata/man/read.xls.Rd 2010-01-24 08:06:23 UTC (rev 1394)
+++ trunk/gdata/man/read.xls.Rd 2010-01-24 08:15:10 UTC (rev 1395)
@@ -2,21 +2,22 @@
\alias{read.xls}
\alias{xls2csv}
\alias{xls2tab}
+\alias{xls2tsv}
\alias{xls2sep}
\title{Read Excel files}
-\description{Reads a Microsoft Excel file into a data frame}
+\description{Read a Microsoft Excel file into a data frame}
\usage{
-read.xls(xls, sheet=1, verbose=FALSE, pattern, ...,
- method=c("csv","tab"), perl="perl")
-
+read.xls(xls, sheet = 1, verbose=FALSE, pattern, ...,
+ method=c("csv","tsv","tab"), perl="perl")
xls2csv(xls, sheet=1, verbose=FALSE, ..., perl="perl")
xls2tab(xls, sheet=1, verbose=FALSE, ..., perl="perl")
-xls2sep(xls, sheet=1, verbose=FALSE, ..., method=c("csv","tab"),
+xls2tsv(xls, sheet=1, verbose=FALSE, ..., perl="perl")
+xls2sep(xls, sheet=1, verbose=FALSE, ..., method=c("csv","tsv","tab"),
perl="perl")
}
\arguments{
- \item{xls}{path to the Microsoft Excel file. To access a file on the
- internet, start the path with "http://".}
+ \item{xls}{path to the Microsoft Excel file. Supports "http://",
+ "https://", and "ftp://" URLS.}
\item{sheet}{number of the sheet within the Excel file from which data
are to be read}
\item{verbose}{logical flag indicating whether details should be
@@ -93,14 +94,34 @@
crime <- read.xls(crime.url, pattern = "State")
# use of xls2csv - open con, print two lines, close con
- con <- xls2csv(nba.url)
+ con <- xls2csv(crime.url)
print(readLines(con, 2))
file.remove(summary(con)$description)
}
+
+ # Examples demonstrating selection of specific 'sheets'
+ # from the example XLS file 'ExampleExcelFile.xls'
+ exampleFile <- file.path(.path.package('gdata'),'xls',
+ 'ExampleExcelFile.xls')
+ exampleFile2007 <- file.path(.path.package('gdata'),'xls',
+ 'ExampleExcelFile.xlsx')
+
+ # see the number and names of sheets:
+ sheetCount(exampleFile)
+ sheetNames(exampleFile2007)
+
+ data <- read.xls(exampleFile) # default is first worksheet
+ data <- read.xls(exampleFile, sheet=2) # second worksheet by number
+ data <- read.xls(exampleFile, sheet="Sheet Second",v=T) # and by name
+
+ # load the third worksheet, skipping the first two non-data lines...
+ data <- read.xls(exampleFile2007, sheet="Sheet with initial text", skip=2)
+
}
-\author{Jim Rogers \email{jam...@pf...}, modified
- and extended by Gregory R. Warnes \email{gr...@ra...}
+\author{
+ Gregory R. Warnes \email{gr...@ra...},
+ Jim Rogers \email{jam...@pf...}, and
Gabor Grothendiek \email{ggr...@gm...}.
}
\keyword{file}
Added: trunk/gdata/man/sheetCount.Rd
===================================================================
--- trunk/gdata/man/sheetCount.Rd (rev 0)
+++ trunk/gdata/man/sheetCount.Rd 2010-01-24 08:15:10 UTC (rev 1395)
@@ -0,0 +1,47 @@
+\name{sheetCount}
+\Rdversion{1.1}
+\alias{sheetCount}
+\alias{sheetNames}
+\title{
+Count or list sheet names in Excel spreadsheet files.
+}
+\description{
+Count or list sheet names in Excel spreadsheet files.
+}
+\usage{
+sheetCount(xls, verbose = FALSE, perl = "perl")
+sheetNames(xls, verbose = FALSE, perl = "perl")
+}
+\arguments{
+ \item{xls}{File path to spreadsheet. Supports "http://",
+ "https://", and "ftp://" URLS.}
+ \item{verbose}{If \code{TRUE}, show additional messages during
+ processing.}
+ \item{perl}{Path to perl interpreter.}
+}
+\value{
+ \code{sheetCount} returns the number of sheets in the spreadsheet.
+ \code{sheetNames} returns the names of sheets in the spreadsheet.
+}
+
+\seealso{
+ \code{\link{read.xls}}, \code{\link{xls2csv}}.
+}
+\examples{
+ xlsfile <- system.file("xls", "iris.xls", package = "gdata")
+ xlsfile
+
+ sheetCount(xlsfile)
+
+
+ exampleFile <- file.path(.path.package('gdata'),'xls',
+ 'ExampleExcelFile.xls')
+ exampleFile2007 <- file.path(.path.package('gdata'),'xls',
+ 'ExampleExcelFile.xlsx')
+
+ sheetCount(exampleFile)
+ sheetNames(exampleFile2007)
+
+
+}
+\keyword{ misc }
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <wa...@us...> - 2010-01-24 18:10:12
|
Revision: 1401
http://r-gregmisc.svn.sourceforge.net/r-gregmisc/?rev=1401&view=rev
Author: warnes
Date: 2010-01-24 18:10:03 +0000 (Sun, 24 Jan 2010)
Log Message:
-----------
Fix R CMD CHECK errors
Modified Paths:
--------------
trunk/gdata/man/read.xls.Rd
Removed Paths:
-------------
trunk/gdata/man/sheetNames.Rd
Modified: trunk/gdata/man/read.xls.Rd
===================================================================
--- trunk/gdata/man/read.xls.Rd 2010-01-24 08:47:27 UTC (rev 1400)
+++ trunk/gdata/man/read.xls.Rd 2010-01-24 18:10:03 UTC (rev 1401)
@@ -113,7 +113,7 @@
data <- read.xls(exampleFile) # default is first worksheet
data <- read.xls(exampleFile, sheet=2) # second worksheet by number
- data <- read.xls(exampleFile, sheet="Sheet Second",v=T) # and by name
+ data <- read.xls(exampleFile, sheet="Sheet Second",v=TRUE) # and by name
# load the third worksheet, skipping the first two non-data lines...
data <- read.xls(exampleFile2007, sheet="Sheet with initial text", skip=2)
Deleted: trunk/gdata/man/sheetNames.Rd
===================================================================
--- trunk/gdata/man/sheetNames.Rd 2010-01-24 08:47:27 UTC (rev 1400)
+++ trunk/gdata/man/sheetNames.Rd 2010-01-24 18:10:03 UTC (rev 1401)
@@ -1,42 +0,0 @@
-\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.
|
|
From: <wa...@us...> - 2012-09-20 17:35:09
|
Revision: 1622
http://r-gregmisc.svn.sourceforge.net/r-gregmisc/?rev=1622&view=rev
Author: warnes
Date: 2012-09-20 17:35:03 +0000 (Thu, 20 Sep 2012)
Log Message:
-----------
Correct .Rd file errors detected by 'R CMD check'.
Modified Paths:
--------------
trunk/gdata/man/MedUnits.Rd
trunk/gdata/man/ans.Rd
trunk/gdata/man/duplicated2.Rd
Modified: trunk/gdata/man/MedUnits.Rd
===================================================================
--- trunk/gdata/man/MedUnits.Rd 2012-09-20 17:15:20 UTC (rev 1621)
+++ trunk/gdata/man/MedUnits.Rd 2012-09-20 17:35:03 UTC (rev 1622)
@@ -17,9 +17,9 @@
\describe{
\item{Abbreviation}{Common Abbreviation (mostly missing)}
\item{Measurement}{Measurement Name}
+ \item{ConventionalUnit}{Conventional Unit}
+ \item{Conversion}{Conversion factor}
\item{SIUnit}{SI Unit}
- \item{Conversion}{Conversion factor}
- \item{ConvetionalUnit}{Conventional Unit}
}
}
\details{
Modified: trunk/gdata/man/ans.Rd
===================================================================
--- trunk/gdata/man/ans.Rd 2012-09-20 17:15:20 UTC (rev 1621)
+++ trunk/gdata/man/ans.Rd 2012-09-20 17:35:03 UTC (rev 1622)
@@ -11,13 +11,13 @@
}
\details{
This function retrieves \code{.Last.value}. For more details see
- \code{\link{Last.value}}.
+ \code{\link[base]{.Last.value}}.
}
\value{
\code{.Last.value}
}
\seealso{
- \code{\link{Last.value}}, \code{\link{eval}}
+ \code{\link[base]{.Last.value}}, \code{\link[base]{eval}}
}
\author{Liviu Andronic}
\examples{
Modified: trunk/gdata/man/duplicated2.Rd
===================================================================
--- trunk/gdata/man/duplicated2.Rd 2012-09-20 17:15:20 UTC (rev 1621)
+++ trunk/gdata/man/duplicated2.Rd 2012-09-20 17:35:03 UTC (rev 1622)
@@ -38,7 +38,7 @@
For more details see \code{\link{duplicated}}.
}
\seealso{
- \code{\link{duplicated}}, \code{\link{unique}}
+ \code{\link[base]{duplicated}}, \code{\link[base]{unique}}
}
\author{Liviu Andronic}
\examples{
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <wa...@us...> - 2015-04-25 07:57:41
|
Revision: 1961
http://sourceforge.net/p/r-gregmisc/code/1961
Author: warnes
Date: 2015-04-25 07:57:39 +0000 (Sat, 25 Apr 2015)
Log Message:
-----------
Add 'justify' argument to print and format object_sizes methods
Modified Paths:
--------------
trunk/gdata/man/humanReadable.Rd
trunk/gdata/man/object.size.Rd
Modified: trunk/gdata/man/humanReadable.Rd
===================================================================
--- trunk/gdata/man/humanReadable.Rd 2015-04-25 07:57:16 UTC (rev 1960)
+++ trunk/gdata/man/humanReadable.Rd 2015-04-25 07:57:39 UTC (rev 1961)
@@ -13,8 +13,7 @@
\usage{
humanReadable(x, units="auto", standard=c("IEC", "SI", "Unix"),
- digits=1, width=NULL, sep=" ", justify=c("right", "left"),
- \dots)
+ digits=1, width=NULL, sep=" ", justify=c("right", "left") )
}
\arguments{
Modified: trunk/gdata/man/object.size.Rd
===================================================================
--- trunk/gdata/man/object.size.Rd 2015-04-25 07:57:16 UTC (rev 1960)
+++ trunk/gdata/man/object.size.Rd 2015-04-25 07:57:39 UTC (rev 1961)
@@ -22,26 +22,30 @@
\method{as}{object_sizes}(x)
-\method{c}{object_sizes}(x)
+\method{c}{object_sizes}(\dots, recursive=FALSE)
\method{format}{object_sizes}(x, humanReadable=getOption("humanReadable"), standard="IEC", units,
- digits=1, width=NULL, sep=" ", \dots)
+ digits=1, width=NULL, sep=" ", justify = c("right", "left"),
+\dots)
-\method{print}{object_sizes}x, quote=FALSE, humanReadable=getOption("humanReadable"),
- standard="IEC", units, digits=1, width=NULL, sep=" ", \dots)
+\method{print}{object_sizes}(x, quote=FALSE, humanReadable=getOption("humanReadable"),
+ standard="IEC", units, digits=1, width=NULL, sep=" ",
+ justify = c("right", "left"), \dots)
}
\arguments{
\item{\dots}{\code{object.size}: \R objects;
- \code{print}: arguments to be passed to other methods.}
+ \code{print} and \code{format}: arguments to be passed to other
+ methods.
+ }
\item{x}{output from \code{object.size}}
\item{quote}{logical, indicating whether or not the result should be
printed with surrounding quotes.}
\item{humanReadable}{logical, use the \dQuote{human readable} format.}
- \item{standard,units,digits,width,sep,justify}{arguments passed to
- \code{\link{humanReadable}}. See the \code{\link{humanReadable}}
- man page for details.
- }
+ \item{standard,units,digits,width,sep,justify}{See the man page for
+ \code{\link{humanReadable}}.
+ }
+ \item{recursive}{See the man page for \code{\link[base]{c}}. }
}
\details{
@@ -60,7 +64,7 @@
space needed to store its name in the symbol table.
Associated space (e.g., the environment of a function and what the
- pointer in a ‘EXTPTRSXP’ points to) is not included in the
+ pointer in a \code{EXTPTRSXP} points to) is not included in the
calculation.
Object sizes are larger on 64-bit builds than 32-bit ones, but
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X