1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
|
\name{colStats}
\alias{colStats}
\alias{colSums,timeSeries-method}
\alias{colMeans,timeSeries-method}
\alias{colSds}
\alias{colVars}
\alias{colSkewness}
\alias{colKurtosis}
\alias{colMaxs}
\alias{colMins}
\alias{colProds}
\alias{colQuantiles}
% \alias{colAvgs}
\alias{colStdevs} % removed, but leave the alias for now
% \alias{mean.timeSeries}
% \alias{var.timeSeries}
\title{Column statistics}
\description{
A collection of functions to compute column statistical properties of
financial and economic time series data.
}
\usage{
colStats(x, FUN, \dots)
colSds(x, \dots)
colVars(x, \dots)
colSkewness(x, \dots)
colKurtosis(x, \dots)
colMaxs(x, \dots)
colMins(x, \dots)
colProds(x, \dots)
colQuantiles(x, prob = 0.05, \dots)
}
% colAvgs(x, \dots)
% \method{mean}{timeSeries}(x, \dots)
% \method{var}{timeSeries}(x, \dots)
\arguments{
\item{x}{
a rectangular object which can be transformed into a matrix
by the function \code{as.matrix}.
}
\item{FUN}{
a function name, the statistical function to be applied.
}
\item{prob}{
a numeric value in [0,1].
}
\item{\dots}{
arguments to be passed.
}
}
\details{
\tabular{ll}{
\code{colStats}\tab calculates column statistics, \cr
\code{colSums} \tab calculates column sums, \cr
\code{colMeans} \tab calculates column means, \cr
\code{colSds} \tab calculates column standard deviations, \cr
\code{colVars} \tab calculates column variances, \cr
\code{colSkewness} \tab calculates column skewness, \cr
\code{colKurtosis} \tab calculates column kurtosis, \cr
\code{colMaxs} \tab calculates maximum values in each column, \cr
\code{colMins} \tab calculates minimum values in each column, \cr
\code{colProds} \tab computes product of all values in each column, \cr
\code{colQuantiles} \tab computes quantiles of each column. }
}
\value{
each function returns a numeric vector of the statistics, one for each
column
}
\seealso{
\code{\link{rollStats}}
}
\examples{
## Simulated Return Data in Matrix Form -
x = matrix(rnorm(252), ncol = 2)
## Mean Columnwise Statistics -
colStats(x, FUN = mean)
## Quantiles Column by Column -
colQuantiles(x, prob = 0.10, type = 1)
}
\keyword{univar}
|