cvFilter-methods             package:xps             R Documentation

_C_o_e_f_f_i_c_i_e_n_t _o_f _V_a_r_i_a_t_i_o_n _F_i_l_t_e_r

_D_e_s_c_r_i_p_t_i_o_n:

     This method initializes the Coefficient of Variation Filter. 
      The coefficient of variation is the standard deviation divided by
     the absolute value of the mean. 
      The CV Filter flags all rows with: 'flag = (cv >= cutoff)'

     _Usage_

         'cvFilter(object)'
         'cvFilter(object, value)<-'

_A_r_g_u_m_e_n_t_s:

  object: object of class 'PreFilter'.

   value: numeric vector 'c(cutoff, trim, epsilon)'.

_D_e_t_a_i_l_s:

     The method 'cvFilter' initializes the following parameters:

         'cutoff':   the cutoff level for the filter.
         'trim':     the trim value for trimmed mean (default is 'trim=0').
         'epsilon':  value to replace mean (default is 'epsilon=0.01'):
                     'epsilon > 0': replace mean=0 with epsilon.
                     'epsilon = 0': always set mean=1.

     Note, that for 'epsilon = 0' the filter flags all rows with: stdev
     >= cutoff

_V_a_l_u_e:

     An initialized 'PreFilter' object.

_A_u_t_h_o_r(_s):

     Christian Stratowa

_E_x_a_m_p_l_e_s:

     prefltr <- PreFilter()
     cvFilter(prefltr) <- c(0.3,0.0,0.01)
     str(prefltr)

