Skip to content

Commit

Permalink
Lightly cleaned up documentation files (spelling, grammar, consistenc…
Browse files Browse the repository at this point in the history 
…y, etc.)

git-svn-id: svn+ssh://svn.r-forge.r-project.org/svnroot/xts/pkg@30 edb9625f-4e0d-4859-8d74-9fd3b1da38cb
  • Loading branch information
@joshuaulrich
joshuaulrich committed Jan 15, 2008
1 parent bd7f2b5 commit 9d8ef29
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 30 deletions.
6 changes: 3 additions & 3 deletions man/as.xts.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ A simple and reliable way to convert many different
objects into a uniform format for use within \R.

It is possible with a call to \code{as.xts} to
convert objects of class \code{timeSeries},\code{ts},
\code{its},\code{matrix},\code{data.frame}, and \code{zoo}.
convert objects of class \code{timeSeries}, \code{ts},
\code{its}, \code{matrix}, \code{data.frame}, and \code{zoo}.

The help file \code{as.xts.methods} lists all available
xts methods and arguments specific to each coercible type.
Expand All @@ -33,7 +33,7 @@ will assure that the attributes are hidden from view, but will
be available via \R's standard \code{attr} function.
The returned object will preserve all relevant attribute/slot
data within itself, allowing for tempory conversion to use
data within itself, allowing for temporary conversion to use
zoo and xts compatible methods. A call to \code{reclass}
returns the object to its original class, with all original
attributes intact - unless otherwise changed.
Expand Down
21 changes: 11 additions & 10 deletions man/as.xts.methods.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,20 @@ losing any attributes of the original format.
\method{as.xts}{xts}(x,...)


\method{as.xts}{timeSeries}(x,dateFormat="POSIXct", FinCenter, recordIDs, title, documentation, ...)
\method{as.xts}{timeSeries}(x, dateFormat="POSIXct", FinCenter, recordIDs,
title, documentation, ...)

\method{as.xts}{its}(x,...)

\method{as.xts}{zoo}(x, order.by = index(x), frequency = NULL, ...)
\method{as.xts}{zoo}(x, order.by=index(x), frequency=NULL, ...)

\method{as.xts}{ts}(x,dateFormat,...)
\method{as.xts}{ts}(x, dateFormat,...)

\method{as.xts}{data.frame}(x, order.by, dateFormat = "POSIXct", frequency = NULL,
...)
\method{as.xts}{data.frame}(x, order.by, dateFormat="POSIXct",
frequency=NULL, ...)

\method{as.xts}{matrix}(x, order.by, dateFormat = "POSIXct", frequency = NULL,
...)
\method{as.xts}{matrix}(x, order.by, dateFormat="POSIXct",
frequency=NULL, ...)
}
\arguments{
\item{x}{ data object to convert. See details for supported types }
Expand All @@ -47,16 +48,16 @@ A simple and reliable way to convert many different
objects into a uniform format for use within \R.

It is possible with a call to \code{as.xts} to
convert objects of class \code{timeSeries},\code{ts},
\code{its},\code{matrix},\code{data.frame}, and \code{zoo}.
convert objects of class \code{timeSeries}, \code{ts},
\code{its}, \code{matrix}, \code{data.frame}, and \code{zoo}.

Additional name=value pairs may be passed to the function
to be added to the new object. A special print.xts method
will assure that the attributes are hidden from view, but will
be available via \R's standard \code{attr} function.
The returned object will preserve all relevant attribute/slot
data within itself, allowing for tempory conversion to use
data within itself, allowing for temporary conversion to use
zoo and xts compatible methods. A call to \code{reclass}
returns the object to its original class, with all original
attributes intact - unless otherwise changed.
Expand Down
2 changes: 1 addition & 1 deletion man/endpoints.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Extract index values of a given \code{xts} object corresponding
to the \emph{last} observations given a period specified by \code{on}
}
\usage{
endpoints(x, on = "months", k = 1)
endpoints(x, on="months", k=1)
}
\arguments{
\item{x}{ an xts object }
Expand Down
2 changes: 1 addition & 1 deletion man/indexClass.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ indexClass(x) <- value
}
\arguments{
\item{x}{ xts object }
\item{value}{ desired new class. see details }
\item{value}{ desired new class. See details }
\item{\dots}{ unused }
}
\details{
Expand Down
16 changes: 8 additions & 8 deletions man/to.period.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
\alias{OHLC}
\title{ Convert time series data to an OHLC series }
\description{
Convert an OHLC or univariate zoo object to a specified periodicity lower
Convert an OHLC or univariate xts object to a specified periodicity lower
than the given data object. For example, convert a daily
series to a monthly series, or a monthly series to an yearly one,
or a one minute series to an hourly series.
Expand All @@ -35,19 +35,19 @@ to.minutes(x,...)
%to.minutes15(x,...)
%to.minutes30(x,...)
to.hourly(x,...)
to.daily(x,drop.time=TRUE,...)
to.daily(x, drop.time=TRUE, ...)

to.weekly(x,drop.time=TRUE,...)
to.monthly(x,indexAt='yearmon',drop.time=FALSE,...)
to.quarterly(x,indexAt='yearqtr',drop.time=FALSE,...)
to.yearly(x,drop.time=TRUE,...)
to.weekly(x, drop.time=TRUE, ...)
to.monthly(x, indexAt="yearmon", drop.time=FALSE, ...)
to.quarterly(x, indexAt="yearqtr", drop.time=FALSE, ...)
to.yearly(x, drop.time=TRUE, ...)

to.period(x, period = months, k = 1, indexAt, name=NULL, ...)
}
\arguments{
\item{x}{ OHLC type object }
\item{period}{ period to convert to }
\item{indexAt}{ convert final index to new class or date. see details }
\item{indexAt}{ convert final index to new class or date. See details }
\item{drop.time}{ remove time component of POSIX datestamp (if any) }
\item{k}{ number of sub periods to aggregate on (only for minutes and seconds) }
\item{name}{ override column names }
Expand All @@ -59,7 +59,7 @@ into any commonly required periodicity. It is important to note
that all dates will be aligned to the \emph{end} of each period,
e.g. the row corresponding to August 2007 would become
'2007-08-31'. This is different than what would be downloaded
from yahoo as a monthly series - as yahoo illogically using the
from yahoo as a monthly series - as yahoo illogically uses the
\emph{beginning} of the month to signify a month - i.e. the first
date available, not the 1st!

Expand Down
2 changes: 1 addition & 1 deletion man/xts-package.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Date: \tab 2008-01-12\cr
License: \tab GPL-3\cr
}
Easily convert one of \R's many time-series (and non-time-series)
classes to a true time based object which inherits all of zoo's
classes to a true time-based object which inherits all of zoo's
methods, while allowing for new time-based tools where appropriate.

Additionally, one may use \pkg{xts} to create new objects which
Expand Down
8 changes: 4 additions & 4 deletions man/xts.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Constructor function for creating an extensible time-series object.
\code{xts} is used to create an \code{xts} object from raw data inputs.
}
\usage{
xts(x, order.by = index(x), frequency = NULL, ...)
xts(x, order.by=index(x), frequency=NULL, ...)

is.xts(x)
}
Expand Down Expand Up @@ -38,13 +38,13 @@ for keeping track of data sources, last update times, financial
instrument descriptions or details.

The idea behind \code{xts} is to offer the user the ability to utilize
a standard zoo object, while providing an mechanism to customise
a standard zoo object, while providing an mechanism to customize
the object's meta-data, as well as create custom methods to handle
the object in a manner required by the user.
Most, if not all, standard zoo methods will work without change. Where
changes where required (to return an xts object) new methods have been
written. At present these modified methods include \sQuote("["), \sQuote{codedata},
written. At present these modified methods include \code{"["}, \code{coredata},
[add more here]
Expand All @@ -54,7 +54,7 @@ python by creating ranges with a double colon "::" operator. Each side of
the operator may be left blank, which would then default to the beginning
and end of the data, respectively. To specify a subset of times,
it is only required that the time specified be in standard ISO format, with
some form of seperation between the elements. The time must be \sQuote{left-filled},
some form of separation between the elements. The time must be \sQuote{left-filled},
that is to specify a full year one needs only to provide the year, a month would require
the full year and the integer of the month requested - e.g. '1999-01'.
This format would extend all the way down to seconds - e.g. '1999-01-01 08:35:23'.
Expand Down
4 changes: 2 additions & 2 deletions man/xtsAttributes.Rd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ xtsAttributes(x) <- value
}
\details{
Since \code{xts} objects are S3 objects with special
attributes, a method is nessasary to properly assign
attributes, a method is necessary to properly assign
and view the user-added attributes.

A call to \code{attributes} from the \pkg{base} package
will return all attributes, including those specific
to the \code{xts} class.
}
\value{
A named list of user settable attributes
A named list of user settable attributes.
}
\author{ Jeffrey A. Ryan }
\seealso{ \code{\link{attributes}}}
Expand Down

0 comments on commit 9d8ef29

Please sign in to comment.