FLFleet                package:FLCore                R Documentation

_C_l_a_s_s _F_L_F_l_e_e_t

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

     The 'FLFleet' class is a composite object storing some useful
     information for the  description and analysis of fleet data,
     including basic information about effort and  economic data. It
     can account for simple or complex patterns such as several types
     of  activities and/or catches of several species.

     FLFleet is thus defined along a three-levelled tree structure.
     First, the root of  FLFleet contains data at the vessel/fleet
     segment levels, independent of activity and  catches, such as
     total effort, capacity, fixed costs and crew share. Then, data
     dealing  with the various types of activity of the fleet are dealt
     with at the metier level  using 'FLMetier' class, which includes
     slots for proportion of effort and variable  costs. 

     Finally, the cath information related to the various species or
     stocks within each  metier are dealt with a 'FLCatch' class. The
     tree structure allows a flexible use  of the FLFleet object, if
     for example not all species are caught by all metiers or if  the
     dimensions are not the same across branches.

     There is a certain degree of flexibility left in the slots
     definition, in the sense  that the user may decide to store either
     raw unit data, for example effort by unit of  capacity, variable
     cost by unit of effort, or to store aggregated data, for example 
     total effort or total variable costs. However, the user should be
     aware that some  computing methods (in FLCore or other related
     packages) are more specifically intended  for one type of data,
     and these should be used with caution.

     A number of accessors are defined for 'FLFleet', allowing to
     extract directly    specific slots at the three-levels FLFleet
     hierarchy i.e. from the 'FLFleet' class itself, from the
     'FLMetier' objects and from the 'FLCatch' objects it  contains. 

     If both catch and metier arguments are specified in those, it
     returns the FLQuant  corresponding to the species. If catch
     argument is missing but metier argument is specified, it returns a
     FLQuants object for all stocks of the 'FLCatches' object  for the
     given specified metier. Finally, if catch argument is specified
     but metier  argument  is missing, it returns a FLQuants object
     across all metiers of the  'FLMetiers' object for the given
     specified species.

     Corresponding replacement methods for these slots exist for the
     FLQuant objects but not  for the FLQuants objects, due to possible
     differences of dimensions across FLMetier  and FLCatch objects.

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


     _e_f_f_o_r_t effort (total or per unit of capacity). 'FLQuant'.

     _f_c_o_s_t Fixed costs (total or per unit of capacity).  'FLQuant'.

     _c_a_p_a_c_i_t_y Capacity of the fleet. 'FLQuant'.

     _c_r_e_w_s_h_a_r_e Crew share (total or per unit of capacity). 'FLQuant'.

     _m_e_t_i_e_r_s FLMetiers object storing a list of FLMetier objects.
          'FLMetiers'.

     _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:


     _c_a_t_c_h(_F_L_C_o_r_e) : Accessor method for the catch slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _c_a_t_c_h._n(_F_L_C_o_r_e) : Accessor method for the catch.n slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _c_a_t_c_h._w_t(_F_L_C_o_r_e) : Accessor method for the catch.wt slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _c_a_t_c_h._s_e_l(_F_L_C_o_r_e) : Accessor method for the catch.sel slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _c_a_t_c_h._q(_F_L_C_o_r_e) : Accessor method for the catch.q slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s(_F_L_C_o_r_e) : Accessor method for the discards slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._n(_F_L_C_o_r_e) : Accessor method for the discards.n slot
          across FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._s_e_l(_F_L_C_o_r_e) : Accessor method for the discards.sel slot
          across FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._w_t(_F_L_C_o_r_e) : Accessor method for the discards.wt slot
          across FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s(_F_L_C_o_r_e) : Accessor method for the landings slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s._n(_F_L_C_o_r_e) : Accessor method for the landings.n slot
          across FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s._w_t(_F_L_C_o_r_e) : Accessor method for the landings.wt slot
          across FLMetiers and FLCatches objects

      ' signature(object=missing) '

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

      ' signature(object=missing) '

     _p_r_i_c_e(_F_L_C_o_r_e) : Accessor method for the price slot across
          FLMetiers and FLCatches objects

      ' signature(object=missing) '

     _c_o_e_r_c_e(_m_e_t_h_o_d_s) : coerces a FLStock object into a FLFleet object.
          This method  is called by typing as(x,"FLFleet"). This will
          first coerce the FLStock object into a FLCatch object, with
          catch.q equal to 1, and then create a FLFleet object with an
          effort  slot equal to max(harvest(x)) so that back
          calculation of harvest as the product of   effort,
          catchability and selectivity is consistent with harvest(x).              

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

     _i_t_e_r(_F_L_C_o_r_e) : return the ith iteration of a FLFleet object. The
          value is of class FLFleet also. 

      ' signature(object="FLFleet") '

     _r_e_v_e_n_u_e(_F_L_C_o_r_e) : describe...

      ' signature(fill...) '

      ' signature(fill...) '

     _s_u_m_m_a_r_y(_m_e_t_h_o_d_s) : returns the summary of the FLFleet object

      ' signature(fill...) '

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

     The FLR Team

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

     catch, catch.n, catch.wt, catch.sel,catch.q, coerce, discards,
     discards.n, discards.sel, discards.wt, landings, landings.n,
     landings.sel, landings.wt, price, FLComp

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

     data(bt4)

     catch(bt4, catch="PLE")   # returns a FLQuants object across metiers
     catch(bt4,met="TBB")   # returns a FLQuants object across catches
     catch(bt4,met="TBB", catch="ple") # returns a FLQuant

     effort(bt4) # a FLFleet slot
     effshare(bt4@metiers[[1]]) # a FLMetier slot for metier 1
     # => metier(bt4,met="OTH") is missing...exist but not in the NAMESPACE?
     catch(bt4@metiers[[1]]@catches[[1]]) # a FLCatch slot for metier 1 and catch 1

