BasicExtensions          package:fUtilities          R Documentation

_M_o_d_i_f_y _a_n_d _E_x_t_e_n_d _R _M_e_t_h_o_d_s

_D_e_s_c_r_i_p_t_i_o_n:

     A collection and description of functions which modify and extend
     generic S functions. 

_U_s_a_g_e:

     ## Default S3 method:
     align(x, y, xout, method = "linear", n = 50, rule = 1, f = 0,
         ties = mean, ...)

     ## Default S3 method:
     attach(what, pos = 2, name = deparse(substitute(what)),
         warn.conflicts = TRUE)

     ## Default S3 method:
     log(x, base = exp(1))

     ## Default S3 method:
     outlier(x, sd = 5, complement = TRUE, ...)

     ## Default S3 method:
     sample(x, size, replace = FALSE, prob = NULL, ...)

     ## Default S3 method:
     var(x, y = NULL, na.rm = FALSE, use)
     ## Default S3 method:
     cov(x, y = NULL, use = "all.obs", 
         method = c("pearson", "kendall", "spearman"))
     ## Default S3 method:
     cor(x, y = NULL, use = "all.obs", 
         method = c("pearson", "kendall", "spearman"))
         
         
     stdev(x, na.rm = FALSE)

     rownames(x) <- value
     colnames(x) <- value

     atoms(x, ...)

     as.POSIXlt(x, tz = "")

     ## S3 method for class 'ts':
     as.matrix(x, ...)
     ## S3 method for class 'mts':
     as.matrix(x, ...)

_A_r_g_u_m_e_n_t_s:

    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)'. 

    name: [attach] - 
           alternative way to specify the database to be attached. See
          for details 'help(attach,package=base)'. 

     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"'. 

      tz: [as.POSIXlt] - 
           time zone specification. 

   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. 
           [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. 

_D_e_t_a_i_l_s:

     For details we refer to the original help pages.

_A_u_t_h_o_r(_s):

     Diethelm Wuertz for the Rmetrics R-port.

_E_x_a_m_p_l_e_s:

     ## Outlier Detection:
        # outlier -
        set.seed(4711)
        x = rnorm(1000)
        outlier(x, sd = 3, complement = FALSE)

