sop                  package:FLCore                  R Documentation

_C_a_l_c_u_l_a_t_e_s _t_h_e _s_u_m _o_f _p_r_o_d_u_c_t_s _c_o_r_r_e_c_t_i_o_n

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

     Calculates the sum of products correction for quantities such a
     catch, discards,  landings.  For example in an object of class
     'FLStock-class' there are  slots _catch.n_, _catch.wt_ and
     _catch_. _catch_ should equal the products of catch.n*catch.wt
     summed over ages. This function returns the ratio (i.e. the
     correction) of _catch.n_*_catch.wt_ : _catch_, which can then be
     used to correct either _catch.n_ or _catch.wt_.

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

     sop(stock, slot)

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

   stock: An FLStock object

    slot: Name of the slot group, i.e. "catch", "landings" or
          "discards" for an FLStock object.

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

     Can be used for any class or slot where there are the three
     FLQuant slots _foo_, _foo.n_ and _foo.wt_, representing totals
     added over all quants (ages), numbers by quant, and weight by
     quant.

_V_a_l_u_e:

     Returns the ratio as an FLQuant

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

     FLR Team

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

     data(ple4)
     sop(ple4,"catch")

