File: statistics-orderStatistics.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 (50 lines) | stat: -rw-r--r-- 934 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
\name{orderStatistics}
\alias{orderStatistics}


\title{Order statistics}

\description{
    Computes the order statistics of a \code{"timeSeries"} object. 
}

\usage{
orderStatistics(x)
}

\arguments{
  \item{x}{
    a \code{"timeSeries"} object.
  }
}

\details{

  \code{orderStatistics} computes the order statistics for each column of a
  \code{"timeSeries"} object. The output is a named list with the order
  statistics for each column in a separate component.
   
}

\value{

  a named list, in which each component is an
  univariate \code{"timeSeries"} containing the order statistics of the
  corresponding column of the input time series.

}

\examples{
## Load Swiss Pension Fund Benchmark Data -  
   setRmetricsOptions(myFinCenter = "GMT")
   X <- LPP2005REC[, "SPI"]
   colnames(X)
   
## Compute 1\% Order Statistics -
   N <- round(0.01*nrow(X))
   N
   OS <- orderStatistics(X)[[1]]
   OS[1:N, ]
}

\keyword{chron}