FLQuantPoint             package:FLCore             R Documentation

_C_l_a_s_s _F_L_Q_u_a_n_t_P_o_i_n_t

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

     The 'FLQuantPoint' class summarizes the contents of an 'FLQuant'
     object with multiple iterations along its sixth dimension using a
     number of descriptive statistics.

     An object of this class has a set structure along its sixth
     dimension (_iter_),  which will always be of length 5, and with
     dimnames _mean_,  _median_, _var_, _uppq_ and _lowq_. They refer,
     respectively, to the sample mean, sample median, variance, and
     lower (0.25) and upper (0.75) quantiles.

     Objects of this class wil be typically created from an 'FLQuant'.
     The various statistics are calculated along the _iter_ dimension
     of the original  'FLQuant' using 'apply'.

_S_l_o_t_s:


     ._D_a_t_a The main array holding the computed statistics. 'array'.

     _u_n_i_t_s Units of measurement. 'character'.

_E_x_t_e_n_d_s:


          FLQuant array

_M_e_t_h_o_d_s:


     _l_o_w_q(_F_L_C_o_r_e) : Accesor for 'lowq' iteration

      ' signature(x=FLQuantPoint) '

     _l_o_w_q<-(_F_L_C_o_r_e) : Modifies the 'lowq' iteration

      ' signature(x=FLQuantPoint,value=FLQuant) '

     _m_e_a_n(_b_a_s_e) : Accesor for 'mean' iteration

      ' signature(x=FLQuantPoint) '

     _m_e_a_n<-(_F_L_C_o_r_e) : Modifies the 'mean' iteration

      ' signature(x=FLQuantPoint,value=FLQuant) '

     _m_e_d_i_a_n(_s_t_a_t_s) : Accesor for 'median' iteration

      ' signature(x=FLQuantPoint,na.rm=missing) '

     _m_e_d_i_a_n<-(_F_L_C_o_r_e) : Modifies the 'median' iteration

      ' signature(x=FLQuantPoint,value=FLQuant) '

     _p_l_o_t(_g_r_a_p_h_i_c_s) : Plot an object of the class

      ' signature(x=FLQuantPoint,y=missing) '

     _q_u_a_n_t_i_l_e(_s_t_a_t_s) : Accesor for 'lowq' or 'uppq' iteration

      ' signature(x=FLQuantPoint) '

     _r_l_n_o_r_m(_s_t_a_t_s) : Creates a lognormally-distributed 'FLQuant' using
          the information on an 'FLQuantPoint'

      ' signature(n=numeric,meanlog=FLQuantPoint,sdlog=missing) '

     _r_n_o_r_m(_s_t_a_t_s) : Creates a normally-distributed 'FLQuant' using the
          information on an 'FLQuantPoint'

      ' signature(n=numeric,mean=FLQuantPoint,sd=missing) '

     _s_h_o_w(_m_e_t_h_o_d_s) : Outputs object in screen

      ' signature(object=FLQuantPoint) '

     _s_u_m_m_a_r_y(_b_a_s_e) : Prints a summary of the object

      ' signature(object=FLQuantPoint) '

     _u_p_p_q(_F_L_C_o_r_e) : Accesor for 'uppq' iteration

      ' signature(x=FLQuantPoint) '

     _u_p_p_q<-(_F_L_C_o_r_e) : Modifies the 'uppq' iteration

      ' signature(x=FLQuantPoint,value=FLQuant) '

     _v_a_r(_s_t_a_t_s) : Accesor for 'var' iteration

      ' signature(x=FLQuantPoint,y=missing,na.rm=missing,use=missing) '

     _v_a_r<-(_F_L_C_o_r_e) : Modifies the 'var' iteration

      ' signature(x=FLQuantPoint,value=FLQuant) '

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

     The FLR Team

_S_e_e _A_l_s_o:

     lowq, lowq<-, mean, mean<-, median, median<-, plot, quantile,
     rlnorm, rnorm, show, summary, uppq, uppq<-, var, var<-, FLQuant,
     array

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

     flq <- FLQuant(rnorm(2000), dim=c(10,20,1,1,1,200))
     flqp <- FLQuantPoint(flq)
     summary(flqp)
     mean(flqp)
     var(flqp)
     rnorm(200, flqp)

