SCM

SCM Repository

[rmetrics] Annotation of /pkg/fCalendar/man/1A-fCalendarUtilities.Rd
ViewVC logotype

Annotation of /pkg/fCalendar/man/1A-fCalendarUtilities.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 691 - (view) (download) (as text)

1 : wuertz 570 \name{fCalendarUtilities}
2 : wuertz 406
3 : wuertz 570 \alias{fCalendarUtilities}
4 : wuertz 406
5 : wuertz 691 \alias{align}
6 :     \alias{align.default}
7 :    
8 : wuertz 406 \alias{log}
9 :     \alias{log.default}
10 :    
11 :     \alias{outlier}
12 :     \alias{outlier.default}
13 :    
14 :     \alias{round}
15 :     \alias{round.default}
16 :    
17 :     \alias{sample}
18 :     \alias{sample.default}
19 :    
20 :     \alias{sort}
21 :     \alias{sort.default}
22 :    
23 :     \alias{var}
24 :     \alias{var.default}
25 :    
26 :     \alias{rownames<-}
27 :     \alias{rownames<-.default}
28 :    
29 :     \alias{colnames<-}
30 :     \alias{colnames<-.default}
31 :    
32 :     \alias{as.POSIXlt}
33 :     \alias{as.POSIXlt.default}
34 :    
35 :     \alias{as.matrix.ts}
36 :     \alias{as.matrix.mts}
37 :    
38 :     \alias{modify}
39 :     \alias{modify.default}
40 :    
41 :     \alias{atoms}
42 :     \alias{atoms.default}
43 :    
44 :     \alias{currentYear}
45 :     \alias{myUnits}
46 :    
47 :    
48 :     \title{Masked Objects and Additional Generic Functions}
49 :    
50 :    
51 :     \description{
52 :    
53 :     A collection and description of functions which
54 :     mask function from R's base installation to generate
55 :     generic functions and some additional generic
56 :     functions which may be useful.
57 :     \cr
58 :    
59 :     }
60 :    
61 :    
62 :     \usage{
63 : wuertz 691 align.default(x, y, xout, method = "linear", n = 50, rule = 1, f = 0,
64 :     ties = mean, \dots)
65 :    
66 : wuertz 406 log.default(x, base = exp(1))
67 :    
68 :     outlier.default(x, sd = 5, complement = TRUE, \dots)
69 :    
70 :     round.default(x, digits, \dots)
71 :    
72 :     sample.default(x, size, replace = FALSE, prob = NULL, \dots)
73 :    
74 :     sort.default(x, partial = NULL, na.last = NA, decreasing = FALSE,
75 :     method = c("shell", "quick"), index.return = FALSE, \dots)
76 :    
77 :     var.default(x, y = NULL, na.rm = FALSE, use)
78 :    
79 :     rownames(x) <- value
80 :     colnames(x) <- value
81 :    
82 :     as.POSIXlt(x, tz = "")
83 :    
84 :     as.matrix.ts(x)
85 :     as.matrix.mts(x)
86 :    
87 :     currentYear
88 :     myUnits
89 :     }
90 :    
91 :    
92 :     \arguments{
93 :    
94 :     \item{base}{
95 :     [log] - \cr
96 :     additional argument to the \code{log} function.
97 :     }
98 :     \item{digits}{
99 :     [round] - \cr
100 :     an integer indicating the precision to be used.
101 :     }
102 : wuertz 691 \item{f}{
103 :     [align] - \cr
104 :     for \code{method="constant"} the value of \code{f} takes a
105 :     number between 0 and 1 inclusive, indicating a compromise between
106 :     left- and right-continuous step functions. If \code{y0} and
107 :     \code{y1} are the values to the left and right of the point then
108 :     the value is \code{y0*(1-f)+y1*f} so that \code{f=0} is
109 :     right-continuous and \code{f=1} is left-continuous.
110 :     }
111 :     \item{method}{
112 :     [align] - \cr
113 :     a character string which specifies the alignment method to be used.
114 :     Choices are \code{"linear"} or \code{"constant"}.
115 :     }
116 :     \item{n}{
117 :     [align] - \cr
118 :     if \code{xout} is not specified, alignment takes place at \code{n}
119 :     equally spaced points spanning the interval \code{range(x)}.
120 :     }
121 :     \item{partial, na.last, decreasing, index.return}{
122 : wuertz 406 [sort] - \cr
123 :     additional arguments to the \code{sort} function.
124 :     }
125 : wuertz 691 \item{rule}{
126 :     [align] - \cr
127 :     an integer describing how alignment is to take place
128 :     outside the interval \code{range(x)}. If \code{rule=1}
129 :     then \code{NA}'s are returned for such points and if
130 :     is \code{rule=2}, the value at the closest data extreme is used.
131 :     }
132 : wuertz 406 \item{sd, complement}{
133 :     [outlier] - \cr
134 :     sd - a numeric value of standard deviations, e.g. 5 means that
135 :     values larger or smaller tahn five times the standard
136 :     deviation of the series will detected.
137 :     complement - a logical flag, should the outlier series
138 :     or its complements be returned ?
139 :     }
140 :     \item{size, replace, prob}{
141 :     [sample] - \cr
142 :     size - is a non-negative integer giving the number of items
143 :     to choose, \cr
144 :     replace - a logical flag. Should sampling be with
145 :     replacement? \cr
146 :     prob - a vector of probability weights for obtaining the
147 :     elements of the vector being sampled.
148 :     }
149 : wuertz 691 \item{ties}{
150 :     [align] - \cr
151 :     handles tied \code{x} values. Either a function with a single
152 :     vector argument returning a single number result or the
153 :     string \code{"ordered"}.
154 :     }
155 : wuertz 406 \item{tz}{
156 :     [as.POSIXlt] - \cr
157 :     time zone specification.
158 :     }
159 :     \item{value}{
160 :     [colnames][rownames] - \cr
161 :     additional arguments to the \code{colnames} and \code{rownames}
162 :     functions.
163 :     }
164 :     \item{x}{
165 : wuertz 691 [align] - \cr
166 :     x-coordinates of the points to be aligned.\cr
167 : wuertz 406 [log][sort][var] - \cr
168 :     first argument.
169 :     \cr
170 :     [as.matrix.ts][as.matrix.mts] - \cr
171 :     an univariate or multivariate time series object
172 :     of class \code{"ts"} or \code{"mts"} which will be
173 :     transformed into an one-column or multi-column rectangular
174 :     object of class \code{"matrix"}.\cr
175 :     [as.POSIXlt] - \cr
176 :     an object to be converted.
177 :     }
178 : wuertz 691 \item{xout}{
179 :     [align] - \cr
180 :     a set of values specifying where interpolation is to take place.}
181 : wuertz 406 \item{y, na.rm, use}{
182 : wuertz 691 [align] - \cr
183 :     y-coordinates of the points to be aligned.\cr
184 : wuertz 406 [var] - \cr
185 :     additional arguments to the \code{var} function.
186 :     }
187 :     \item{\dots}{
188 :     arguments to be passed.
189 :     }
190 :    
191 :     }
192 :    
193 :    
194 :     \details{
195 :    
196 :     For details we refer to the original help pages.
197 :    
198 :     }
199 :    
200 :    
201 :    
202 :     \author{
203 :    
204 :     Diethelm Wuertz for the Rmetrics \R-port.
205 :    
206 :     }
207 :    
208 :    
209 :     \examples{
210 : wuertz 570 ## SOURCE("fCalendar.1A-fCalendarUtilities")
211 : wuertz 406 }
212 :    
213 :    
214 :     \keyword{programming}
215 :    

R-Forge@R-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business University of Wisconsin - Madison Powered By FusionForge