computeCatch             package:FLCore             R Documentation

_M_e_t_h_o_d_s _t_o _c_o_m_p_u_t_e _t_o_t_a_l _c_a_t_c_h, _l_a_n_d_i_n_g_s, _d_i_s_c_a_r_d_s _a_n_d _s_t_o_c_k _b_i_o_m_a_s_s

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

     These methods compute the total catch, landings, discards and
     stock biomass from the quant-structured values in numbers and
     weight per individual. The calculation for discards, landings and
     stock involves the product of the landings/discards/stock in
     numbers ('landings.n', 'discards.n' or 'stock.n') by the
     individual weight-at-quant ('landings.wt', 'discards.wt' or
     'stock.wt'), as in


                 landings = landings.n * landings.wt


     By selecting 'slot="catch"', 'computeCatch' can calculate in the
     same way the total catch from the catch-at-quant and weight in the
     catch. Those two values (in slots 'catch.n' and 'catch.wt' can
     also be calculated by specifying  'slot="n"' and 'slot="wt"'
     respectively. Calling 'computeCatch' with option 'slot="all"' will
     carry out the three calculations. In this case, the returned
     object will be of class 'FLQuants', with elements names 'catch',
     'catch.n' and 'catch.wt', which can then be passed directly to the
     'catch<-' replacement method.

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

     computeCatch(object, ...) 

     computeLandings(object, ...) 

     computeDiscards(object, ...) 

     computeStock(object, ...)

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


     '_o_b_j_e_c_t' : an object of a class for which this method has been
          defined.

     '_s_l_o_t' : a character vector to select the calculation to perform
          in 'computeCatch'. One of "n", "wt", "all" or "catch", the
          default value. The later will compute the total catch (for
          slot 'catch') from 'catch.n' and 'catch.wt'

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

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


      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_F_L_C_a_t_c_h) : computation on an 'FLCatch' object.

      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_F_L_S_t_o_c_k) : computation on an 'FLStock' object.

      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_F_L_I_n_d_e_x) : computation on an 'FLIndex' object.

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

     The FLR Team

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

     FLComp

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

     data(ple4)
     summary(computeLandings(ple4))
     landings(ple4) <- computeLandings(ple4)
     catch(ple4) <- computeCatch(ple4, slot="all")

