FLQuantSums              package:FLCore              R Documentation

_M_e_t_h_o_d_s _t_o _c_o_m_p_u_t_e _s_u_m_s, _m_e_a_n_s _a_n_d _v_a_r_s _o_f _F_L_Q_u_a_n_t _o_b_j_e_c_t_s

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

     This set of methods computes three different summaries (sum, mean
     and variance) of an 'FLQuant' object along each of the six
     dimensions (quant, year, unit, season, area, or iter). Three
     methods ('dimSums', 'dimMeans' and 'dimVars') operate by default
     over the second to fifth dimensions ('unit', 'season' and 
     'area').

     These methods simply encapsulate a call to 'apply' with the 
     corresponding dimension and function.

     Sums are not calculated for the 'iter' dimension, as it is used to
     store multiple  replicates of a given array of values.

     Methods to operate over the first dimension refer to it as the
     'quant' dimension, regardless of the actual name used in the
     object.

     The output object will have length=1 on the selected dimension.

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

     quantSums(x), quantMeans(x), quantVars(x) 

     yearSums(x), yearMeans(x), yearVars(x) 

     unitSums(x), unitMeans(x), unitVars(x) 

     seasonSums(x), seasonMeans(x), seasonVars(x) 

     areaSums(x), areaMeans(x), areaVars(x) 

     iterMeans(x), iterVars(x) 

     dimSums(x), dimMeans(x), dimVars(x)

_M_e_t_h_o_d _a_r_g_u_m_e_n_t_s:


     '_x' : an object of a class for which this method has been defined.

     '_n_a._r_m' : a logical indicating whether 'NA's should be deleted
          from the calculations. Defaults to 'TRUE'.

     '_d_i_m' : numeric, the dimensions over which 'dimSums', 'dimMeans'
          or  'dimVars' should operate. Defaults to 'c(1:2,6)'.

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


      _s_i_g_n_a_t_u_r_e(_x=_F_L_Q_u_a_n_t) : Computes a given summary statistic over a
          certain dimension  of an FLQuant.

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

     The FLR Team

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

     FLQuant, sum, mean, var

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

      flq <- FLQuant(rnorm(4000), dim=c(5,10,2,2,2,10), quant='age')
      quantSums(flq)
      quantMeans(flq)
      yearSums(flq)
      iterMeans(flq)
      dim(quantSums(flq))

