FLCatch                package:FLCore                R Documentation

_C_l_a_s_s _F_L_C_a_t_c_h

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

     An internal class for 'FLMetier' objects that stores stock or
     species specific  information on landings, discards and catches,
     catchability and price.

     Catches are computed as the sum of landings and discards.

     Landings, discards and catches are described with four slots each,
     one intented to deal with age (or other quant)-aggregated total
     estimate and three intented to deal with age (or other
     quant)-disaggregated information (numbers at age, mean weight at
     age and      selectivity at age).

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


     _c_a_t_c_h._q Catchability in the catches. Can be quant-disagggregated
          or not. 'FLQuant'.

     _l_a_n_d_i_n_g_s Total landings in weight. 'FLQuant'.

     _l_a_n_d_i_n_g_s._n Numbers at quant in landings. 'FLQuant'.

     _l_a_n_d_i_n_g_s._w_t Mean weight at quant in catches. 'FLQuant'.

     _l_a_n_d_i_n_g_s._s_e_l Selectivity at quant in the catches. 'FLQuant'.

     _d_i_s_c_a_r_d_s Total discards in weight. 'FLQuant'.

     _d_i_s_c_a_r_d_s._n Numbers at quant in catches. 'FLQuant'.

     _d_i_s_c_a_r_d_s._w_t Mean weight at quant in discards. 'FLQuant'.

     _d_i_s_c_a_r_d_s._s_e_l Selectivity at quant in the discards. 'FLQuant'.

     _p_r_i_c_e mean price. Can be quant-disagggregated or not. 'FLQuant'. 

     _n_a_m_e Generic name slot inherited from FLComp class. 'character'.

     _d_e_s_c Generic description slot inherited from FLComp class.
          'character'.

     _r_a_n_g_e Generic range slot inherited from FLComp class indicating
          min quant, max quant, plusgroup quant,minyear and maxyear.
          'numeric'.

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


          FLComp

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


     _a_s._d_a_t_a._f_r_a_m_e(_b_a_s_e) : coerces the FLCatch object to a data.frame.
          Slot names are passed in the slot column. The name, desc and
          range slots is passed as an attribute of the data.frame

      ' signature(x=FLCatch, row.names=missing, optional=missing) '

     _c_a_t_c_h(_F_L_C_o_r_e) : accessor method for the catch slot

      ' signature(object=FLCatch) '

     _c_a_t_c_h._q(_F_L_C_o_r_e) : accessor method for the catch.q slot

      ' signature(object=FLCatch) '

     _c_a_t_c_h._q<-(_F_L_C_o_r_e) : replacement method for the catch.q slot

      ' signature(object=FLCatch, value=FLQuant) '

     _c_a_t_c_h._n(_F_L_C_o_r_e) : returns catch in numbers by quant as sum of
          landings.n and discards.n

      ' signature(object=FLCatch) '

     _c_a_t_c_h._s_e_l(_F_L_C_o_r_e) : returns catch.sel as calculated from
          landings.sel and discards.sel

      ' signature(object=FLCatch) '

     _c_a_t_c_h._s_e_l<-(_F_L_C_o_r_e) : replacement method for the catch.sel slot

      ' signature(object=FLCatch, value=FLQuant) '

     _c_a_t_c_h._w_t(_F_L_C_o_r_e) : returns catch.wt as a weighted mean of
          landings.wt and discards.wt

      ' signature(object=FLCatch) '

     _d_i_s_c_a_r_d_s(_F_L_C_o_r_e) : accessor method for the discards slot

      ' signature(object=FLCatch) '

     _d_i_s_c_a_r_d_s<-(_F_L_C_o_r_e) : replacement method for the discards slot

      ' signature(object=FLCatch,value=FLQuant) '

     _d_i_s_c_a_r_d_s._n(_F_L_C_o_r_e) : accessor method for the discards.n slot

      ' signature(object=FLCatch) '

     _d_i_s_c_a_r_d_s._n<-(_F_L_C_o_r_e) : replacement method for the discards.n slot

      ' signature(object=FLCatch,value=FLQuant) '

     _d_i_s_c_a_r_d_s._s_e_l(_F_L_C_o_r_e) : accessor method for the discards.sel slot

      ' signature(object=FLCatch) '

     _d_i_s_c_a_r_d_s._s_e_l<-(_F_L_C_o_r_e) : replacement method for the discards.sel
          slot

      ' signature(object=FLCatch,value=FLQuant) '

     _d_i_s_c_a_r_d_s._w_t(_F_L_C_o_r_e) : accessor method for the discards.wt slot

      ' signature(object=FLCatch) '

     _d_i_s_c_a_r_d_s._w_t<-(_F_L_C_o_r_e) : replacement method for the discards.wt
          slot

      ' signature(object=FLCatch,value=FLQuant) '

     _l_a_n_d_i_n_g_s(_F_L_C_o_r_e) : accessor method for the landings slot

      ' signature(object=FLCatch) '

     _l_a_n_d_i_n_g_s<-(_F_L_C_o_r_e) : replacement method for the landings slot

      ' signature(object=FLCatch,value=FLQuant) '

     _l_a_n_d_i_n_g_s._n(_F_L_C_o_r_e) : accessor method for the landings.n slot

      ' signature(object=FLCatch) '

     _l_a_n_d_i_n_g_s._n<-(_F_L_C_o_r_e) : replacement method for the landings.n slot

      ' signature(object=FLCatch,value=FLQuant) '

     _l_a_n_d_i_n_g_s._s_e_l(_F_L_C_o_r_e) : accessor method for the landings.sel slot

      ' signature(object=FLCatch) '

     _l_a_n_d_i_n_g_s._s_e_l<-(_F_L_C_o_r_e) : replacement method for the landings.sel
          slot

      ' signature(object=FLCatch,value=FLQuant) '

     _l_a_n_d_i_n_g_s._w_t(_F_L_C_o_r_e) : accessor method for the landings.wt slot

      ' signature(object=FLCatch) '

     _l_a_n_d_i_n_g_s._w_t<-(_F_L_C_o_r_e) : replacement method for the landings.wt
          slot

      ' signature(object=FLCatch,value=FLQuant) '

     _p_r_i_c_e(_F_L_C_o_r_e) : accessor method for the price slot

      ' signature(object=FLCatch) '

     _p_r_i_c_e<-(_F_L_C_o_r_e) : replacement method for the price slot

      ' signature(object=FLCatch,value=FLQuant) '

     _F_L_F_l_e_e_t(_F_L_C_o_r_e) : creates a FLFleet object with one single metier
          from a FLCatch object. All other FLFleet and FLMetier slots
          are set to NA.  

      ' signature(object=FLCatch) '

     _F_L_M_e_t_i_e_r(_F_L_C_o_r_e) : creates a FLMetier object from a FLCatch
          object. Effshare and vcost slots are set to NA.

      ' signature(catches=FLCatch) '

     _c_o_e_r_c_e(_m_e_t_h_o_d_s) : coerces a FLStock object into a FLCatch object. 
          This method is called with as(x,"FLCatch"). In that case,
          catch.sel is calculated as harvest(x)/max(harvest(x)),
          catch.q is set to 1 and landings.sel and discards.sel are
          calculated proportionally to numbers

      ' signature(from=NULL,to=FLCatch,strict=missing) '

     _c_o_m_p_u_t_e_C_a_t_c_h(_F_L_C_o_r_e) : computes the total catch from the
          quant-structured values in numbers and weight per individual.

      ' signature(object=FLCatch) '

     _c_o_m_p_u_t_e_D_i_s_c_a_r_d_s(_F_L_C_o_r_e) : computes the total discards from the
          quant-structured values in numbers and weight per individual.

      ' signature(object=FLCatch) '

     _c_o_m_p_u_t_e_L_a_n_d_i_n_g_s(_F_L_C_o_r_e) : computes the total landings from the
          quant-structured values in numbers and weight per individual.

      ' signature(object=FLCatch) '


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

     The FLR Team

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

     as.data.frame, catch, catch<-, catch.q, catch.q<-, catch.n,
     catch.n<-, catch.sel, catch.sel<-, catch.wt, catch.wt<-, coerce,
     computeCatch, computeDiscards, computeLandings, discards,
     discards<-, discards.n, discards.n<-, discards.sel,
     discards.sel<-, discards.wt, discards.wt<-, FLFleet, FLMetier,
     landings, landings<-, landings.n, landings.n<-, landings.sel,
     landings.sel<-, landings.wt, landings.wt<-, price, price<-, FLComp

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

     data(ple4)
     mycatch<-as(ple4,"FLCatch")

     landings(mycatch)<-computeLandings(mycatch)
     landings(mycatch)

