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
|
\name{periodical}
\alias{endOfPeriod}
\alias{endOfPeriodSeries}
\alias{endOfPeriodStats}
\alias{endOfPeriodBenchmarks}
\title{End-of-Period series, stats, and benchmarks}
\description{
Computes periodical statistics back to a given period.
}
\usage{
endOfPeriodSeries(x,
nYearsBack = c("1y", "2y", "3y", "5y", "10y", "YTD"))
endOfPeriodStats(x,
nYearsBack = c("1y", "2y", "3y", "5y", "10y", "YTD"))
endOfPeriodBenchmarks(x, benchmark = ncol(x),
nYearsBack = c("1y", "2y", "3y", "5y", "10y", "YTD"))
}
\arguments{
\item{x}{
an end-of-month recorded multivariate \code{"timeSeries"} object.
One of the columns holds the benchmark series specified by argument
\code{benchmark},
}
\item{nYearsBack}{
a period string. How long back should the series be treated? Options
include values from 1 year to 10 years, and year-to-date: "1y",
"2y", "3y", "5y", "10y", "YTD".
}
\item{benchmark}{
an integer giving the position of the benchmark series in
\code{x}. By default this is the last column of \code{x}.
}
}
\details{
\code{endOfPeriodSeries} extract the data for the last few years, as
specified by argument \code{nYearsBack}.
\code{endOfPeriodStats} computes basic exploratory statistics for the
last few years in the data.
\code{endOfPeriodBenchmarks} returns benchmarks back to a given
period.
\code{x} must be end of month data. Such series can be created using
functions like \code{align}, \code{alignDailySeries},
\code{daily2monthly}.
}
\value{
for \code{endOfPeriodSeries}, a \code{"timeSeries"},
for \code{endOfPeriodStats}, a data frame,
for \code{endOfPeriodBenchmarks} - currently \code{NULL} (invisibly),
the function is unfinished.
}
\examples{
## load series: column 1:3 Swiss market, column 8 (4) benchmark
x <- 100 * LPP2005REC[, c(1:3, 8)]
colnames(x)
x <- daily2monthly(x)
x
## Get the Monthly Series -
endOfPeriodSeries(x, nYearsBack="1y")
## Compute the Monthly Statistics
endOfPeriodStats(x, nYearsBack="1y")
## Compute the Benchmark
endOfPeriodBenchmarks(x, benchmark=4)
}
\keyword{chron}
|
