baseMethods {fUtilities} | R Documentation |
Generic Functions Extensions
Description
Basic extensions which which add and/or modify
additional functionality which is not available
in R's basic packages.
Added and/or modified functions:
align | adds align function, |
atoms | adds atoms function, |
attach | extends attach function, |
colnames<- | adds colnames assignment, |
cor | extends cor function, |
cov | extends cov function, |
log | extends log function, |
outlier | adds outlier function, |
rank | extends rank function, |
rownames<- | adds rownames assigment, |
sample | extends sample function, |
stdev | adds stdev function, |
termPlot | adds term plot function, |
var | extends var function, |
volatility | adds volatility function. |
Usage
## Default S3 method:
align(x, y, xout, method = "linear", n = 50, rule = 1,
f = 0, ties = mean, ...)
## Default S3 method:
atoms(x, ...)
## Default S3 method:
attach(what, pos = 2, name = deparse(substitute(what)),
warn.conflicts = TRUE)
## Default S3 method:
cor(x, y = NULL, use = "everything",
method = c("pearson", "kendall", "spearman"))
## Default S3 method:
cov(x, y = NULL, use = "everything",
method = c("pearson", "kendall", "spearman"))
## Default S3 method:
log(x, base = exp(1))
## Default S3 method:
outlier(x, sd = 5, complement = TRUE, ...)
## Default S3 method:
rank(x, na.last = TRUE,
ties.method = c("average", "first", "random", "max", "min"))
## Default S3 method:
sample(x, size, replace = FALSE, prob = NULL, ...)
## Default S3 method:
stdev(x, na.rm = FALSE)
## Default S3 method:
termPlot(model, ...)
## Default S3 method:
var(x, y = NULL, na.rm = FALSE, use)
## Default S3 method:
volatility(object, ...)
rownames(x) <- value
colnames(x) <- value
Arguments
base |
[log] -
additional argument to the log function.
See for details help(log,package=base) .
|
f |
[align] -
for method="constant" the value of f takes a
number between 0 and 1 inclusive, indicating a compromise between
left- and right-continuous step functions. If y0 and
y1 are the values to the left and right of the point then
the value is y0*(1-f)+y1*f so that f=0 is
right-continuous and f=1 is left-continuous.
|
method |
[align] -
a character string which specifies the alignment method to be used.
Choices are "linear" or "constant" .
[cov] -
a character string indicating which correlation coefficient (or
covariance) is to be computed. One of "pearson" (default) ,
"kendall" , or "spearman" , can be abbreviated.
|
n |
[align] -
if xout is not specified, alignment takes place at n
equally spaced points spanning the interval range(x) .
|
na.last |
[rank] -
for controlling the treatment of NAs. If TRUE , missing
values in the data are put last; if FALSE , they are put
first; if NA , they are removed; if "keep" they are
kept with rank NA .
|
name |
[attach] -
alternative way to specify the database to be attached.
See for details help(attach,package=base) .
|
model |
[termPlot] -
a fitted model object.
|
object |
[volatility] -
an object from which to extract the volatility.
|
pos |
[attach] -
an integer specifying position in search() where to attach
the database.
See for details help(attach,package=base) .
|
rule |
[align] -
an integer describing how alignment is to take place
outside the interval range(x) . If rule=1
then NA 's are returned for such points and if
is rule=2 , the value at the closest data extreme is used.
|
sd, complement |
[outlier] -
sd - a numeric value of standard deviations, e.g. 5 means that
values larger or smaller tahn five times the standard
deviation of the series will detected.
complement - a logical flag, should the outlier series
or its complements be returned ?
|
size, replace, prob |
[sample] -
size - is a non-negative integer giving the number of items
to choose,
replace - a logical flag. Should sampling be with
replacement?
prob - a vector of probability weights for obtaining the
elements of the vector being sampled.
|
ties |
[align] -
handles tied x values. Either a function with a single
vector argument returning a single number result or the
string "ordered" .
|
ties.method |
[rank] -
a character string, one of "average" , "first" ,
"random" , "max" , "min" specifying how
ties are treated, can be abbreviated, see rank .
|
value |
[colnames][rownames] -
additional arguments to the colnames and rownames
functions.
|
warn.conflicts |
[attach] -
a logical value. If TRUE , warnings are printed about
conflicts from attaching the database, unless that database
contains an object .conflicts.OK . A conflict is a
function masking a function, or a non-function masking a
non-function.
See for details help(attach,package=base) .
|
what |
[attach] -
database to be attached. This may currently be a timeSeries object,
a data.frame or a list or a R data file created with save or NULL
or an environment.
See for details help(attach,package=base) .
|
x |
[align] -
x-coordinates of the points to be aligned.
[log][sort][var] -
first argument.
[print.control] - cr
prints an unlisted object of class control.
[as.matrix.ts][as.matrix.mts] -
an univariate or multivariate time series object
of class "ts" or "mts" which will be
transformed into an one-column or multi-column rectangular
object of class "matrix" .
[as.POSIXlt] -
an object to be converted.
|
xout |
[align] -
a set of values specifying where interpolation is to take place.
|
y, na.rm, use |
[align] -
y-coordinates of the points to be aligned.
[var] -
additional arguments to the var function.
[cov] -
additional arguments to the cov function.
|
... |
arguments to be passed.
|
Details
For details we refer to the original help pages.
Examples
## Very Simple Outlier Detection:
# outlier -
set.seed(4711)
x = rnorm(1000)
outlier(x, sd = 3, complement = FALSE)
[Package
fUtilities version 2110.78
Index]