File: statistics-rowCumsums.Rd

package info (click to toggle)
r-cran-timeseries 4041.111-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,704 kB
  • sloc: makefile: 14
file content (54 lines) | stat: -rw-r--r-- 905 bytes parent folder | download
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
\name{rowCum}
\alias{rowCum}

\alias{rowCumsums}
\alias{rowCumsums,ANY-method}
\alias{rowCumsums,timeSeries-method}


\title{Cumulative row statistics}

\description{
  Compute cumulative row statistics.
}

\usage{
\S4method{rowCumsums}{ANY}(x, na.rm = FALSE, \dots)
\S4method{rowCumsums}{timeSeries}(x, na.rm = FALSE, \dots)
}

\arguments{
  
  \item{x}{

    a time series, may be an object of class \code{"matrix"} or
    \code{"timeSeries"}.

  }
  \item{na.rm}{
    a logical. Should missing values be removed?
  }
  \item{\dots}{
    arguments to be passed.
  }
}

\value{
  for the default method, a matrix,
  
  for the \code{"timeSeries"} method, an S4 object of class \code{"timeSeries"}.
}

\seealso{
  \code{\link[=colCum]{colCumXXX}}
}

\examples{
## Simulated Monthly Return Data - 
   X = matrix(rnorm(24), ncol = 2)
     
## Compute cumulated Sums -
   rowCumsums(X)  
}

\keyword{univar}