quantile               package:FLCore               R Documentation

_M_e_t_h_o_d _q_u_a_n_t_i_l_e

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

     Quantiles for 'FLQuant-class' objects can be obtained with this
     method.  Default quantiles returned are 'seq(0, 1, 0.25)', but
     they can be specified using the 'probs' argument. The returned
     'FLQuant-class' object uses the  sixth dimension (_iter_) to store
     the requested quantiles, with appropriate  dimnames.

     For objects of class 'FLQuantPoint-class', quantile is merely an
     accessor for two elements of the sixth dimension, 'lowq' and
     'uppq'. You could  use the 'lowq' and 'uppq' methods instead.

_G_e_n_e_r_i_c _f_u_n_c_t_i_o_n:

     quantile(x, ...)

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


      _s_i_g_n_a_t_u_r_e(_x=_F_L_Q_u_a_n_t) : Describe method

      _s_i_g_n_a_t_u_r_e(_x=_F_L_Q_u_a_n_t_P_o_i_n_t) : Describe method

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

     The FLR Team

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

     quantile, FLQuant-class, FLQuantPoint-class

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

     # Normally distributed FLQuant, with log-normal random mean and fixed sd of 20
     flq <- rnorm(100, FLQuant(rlnorm(20), dim=c(2,10)), 20)

     # obtains all standard quantiles (0, 0.25, 0.5, 0.75 and 1)
     quantile(flq)
     # select one of them by name
     quantile(flq)[,,,,,'0.75']
     # calculates the 0.05 quantile only
     quantile(flq, 0.05)

     # creates an FLQuantPoint from previous FLQuant
     flp <- FLQuantPoint(flq)
     # return each of the two quantiles (025 and 0.75)
     quantile(flp, 0.25)
     quantile(flp, 0.75)

