FLIndex                package:FLCore                R Documentation

_C_l_a_s_s _F_L_I_n_d_e_x

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

     A class designed to hold data and parameters related to abundance
     indices

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


     _t_y_p_e ('character') Type of index

     _d_i_s_t_r_i_b_u_t_i_o_n ('character'): Statistical distribution of the index
          values

     _i_n_d_e_x ('FLQuant'): Index values

     _i_n_d_e_x._v_a_r ('FLQuant'): Variance of the index

     _c_a_t_c_h._n ('FLQuant'): Catch numbers used to create the index

     _c_a_t_c_h._w_t ('FLQuant'): Catch weight of the index

     _e_f_f_o_r_t ('FLQuant'): Effort used to create the index

     _s_e_l._p_a_t_t_e_r_n ('FLQuant'): Selection pattern for the index

     _i_n_d_e_x._q ('FLQuant'): Catchability of the index

     _n_a_m_e ('character'): Name of the stock inherited from FLComp-class

     _d_e_s_c ('character'): General description of the object inherited
          from FLComp-class

     _r_a_n_g_e ('numeric'):{Range of the object inherited from
          FLComp-class}

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


          FLComp

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


     _c_a_t_c_h._n(_F_L_C_o_r_e) : Accessor for the catch.n slot in the object

      ' signature(object=missing) '

     _c_a_t_c_h._n<-(_F_L_C_o_r_e) : Replacement function for the catch.n slot in
          the object

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

     _c_a_t_c_h._w_t(_F_L_C_o_r_e) : Accessor for the catch.n slot in the object

      ' signature(object=missing) '

     _c_a_t_c_h._w_t<-(_F_L_C_o_r_e) : replacement function for the catch.wt slot in
          the object

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

     _c_o_e_r_c_e(_m_e_t_h_o_d_s) : Describe method

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

     _c_o_m_p_u_t_e_C_a_t_c_h(_F_L_C_o_r_e) : Compute the catch in the FLIndex method, as
          catch.n and catch.wt

      ' signature(object=missing) '

     _d_i_m_s(_F_L_C_o_r_e) : returns the dims of the objects

      ' signature(obj=missing) '

     _i_t_e_r(_F_L_C_o_r_e) : To extract or modify a subset of the iterations
          contained in the FLIndex object, the  'iter' and 'iter<-'
          methods can be used

      ' signature(object=missing) '

     _p_l_o_t(_g_r_a_p_h_i_c_s) : Plot the FLIndex-class, takes an additional
          argument type, which defines the type of plot

      ' signature(x=FLIndex,y=missing) '

     _p_r_o_p_a_g_a_t_e(_F_L_C_o_r_e) : 'FLIndex' objects with a single iteration
          (length of 1 in the sixth dimension) can be extended using
          the 'propagate' method. The 'type' argument selects whether
          the new iterations are filled with the content of the first
          iteration ('type='all'') or left empty ('type='first'') 

      ' signature(object=missing) '

     _s_u_m_m_a_r_y(_b_a_s_e) : summary is a generic function used to produce
          result summaries of the 'FLIndex'

      ' signature(object=missing) '

     _t_r_a_n_s_f_o_r_m(_b_a_s_e) : Transform allows to change a number of slots of
          class FLQuant to be changed at once

      ' signature(_data=missing) '

     _t_r_i_m(_F_L_C_o_r_e) : Subsetting of FLIdex object can be carried out
          using the dimension names by using  'trim'. A number of
          dimension names and selected dimensions are passed to the
          method and those are used to subset the input object.

      ' signature(object=missing) '

     _w_i_n_d_o_w(_s_t_a_t_s) : This method extracts a section of or extends the
          FLInedex object along the 'year' dimension. If a frequency is
          specified, the new object contains data at only those year
          steps.

      ' signature(x=missing) '

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

     The FLR Team

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

     catch.n, catch.n<-, catch.wt, catch.wt<-, coerce, computeCatch,
     dims, iter, plot, propagate, summary, transform, trim, window,
     FLComp

