FLQuant                package:FLCore                R Documentation

_F_L_Q_u_a_n_t _c_l_a_s_s _f_o_r _n_u_m_e_r_i_c_a_l _d_a_t_a

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

     The 'FLQuant' class is a six-dimensional 'array' designed to 
     store most quantitative data used in fisheries and population
     modelling.

     The sixth dimensions are named. The name of the first dimension
     can be altered by the user from its default, 'quant'. This could
     typically be 'age' or  'length' for data related to natural
     populations. Other dimensions are always names as follows: 'year',
     for the calendar year of the datapoint; 'unit', for  any kind of
     division of the population, e.g. by sex; 'season', for any
     temporal strata shorter than year; 'area', for any kind of spatial
     stratification; and  'iter', for replicates obtained through
     bootstrap, simulation or Bayesian analysis.

     In addition, 'FLQuant' objects contain a 'units' attribute, of
     class  'character', intended to contain the units of measurement
     relevant to  the data.

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


     ._D_a_t_a A 6-D array for numeric data. 'array'.

     _u_n_i_t_s Units of measurement. 'character'.

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


          FLArray array

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


     [(_b_a_s_e) : Extract elements

      ' signature(x=FLQuant,i=ANY,j=ANY,drop=missing) '

     [<-(_b_a_s_e) : Substitute elements

      ' signature(x=FLQuant,i=ANY,j=ANY,value=missing) '

     _a_p_p_l_y(_b_a_s_e) : Operate with a function along certain dimensions

      signature(X=FLQuant,MARGIN=missing,FUN=missing)

     _A_r_i_t_h(_b_a_s_e) : Arithmetic operations

      ' signature(e1=FLQuant,e2=FLQuant) '

     _a_s._d_a_t_a._f_r_a_m_e(_b_a_s_e) : Convert to a data.frame with 7 columns

      ' signature(x=FLQuant,row.names=ANY,optional=ANY) '

     _a_s._F_L_Q_u_a_n_t(_F_L_C_o_r_e) : Convert into an FLQuant

      ' signature(x=missing) '

     _b_a_r_c_h_a_r_t(_l_a_t_t_i_c_e) : Plot a barchart following the given formula

      ' signature(x=formula,data=FLQuant) '

     _b_u_b_b_l_e_s(_F_L_C_o_r_e) : Plot a bubble following the given formula, with
          size of the bubbles given by the values in the object

      ' signature(x=formula,data=FLQuant) '

     _b_w_p_l_o_t(_l_a_t_t_i_c_e) : Describe method

      ' signature(x=formula,data=FLQuant) '

     _c_a_t_c_h<-(_F_L_C_o_r_e) : Describe method

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

     _c_a_t_c_h<-(_F_L_C_o_r_e) : Describe method

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

     _c_a_t_c_h._n<-(_F_L_C_o_r_e) : Describe method

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

     _c_a_t_c_h._n<-(_F_L_C_o_r_e) : Describe method

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

     _c_a_t_c_h._n<-(_F_L_C_o_r_e) : Describe method

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

     _c_a_t_c_h._w_t<-(_F_L_C_o_r_e) : Describe method

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

     _c_a_t_c_h._w_t<-(_F_L_C_o_r_e) : Describe method

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

     _c_a_t_c_h._w_t<-(_F_L_C_o_r_e) : Describe method

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

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

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

     _c_v(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _d_i_m_n_a_m_e_s<-(_b_a_s_e) : Describe method

      ' signature(x=missing,value=missing) '

     _d_i_m_s(_F_L_C_o_r_e) : Describe method

      ' signature(obj=missing) '

     _d_i_s_c_a_r_d_s<-(_F_L_C_o_r_e) : Describe method

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

     _d_i_s_c_a_r_d_s<-(_F_L_C_o_r_e) : Describe method

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

     _d_i_s_c_a_r_d_s._n<-(_F_L_C_o_r_e) : Describe method

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

     _d_i_s_c_a_r_d_s._n<-(_F_L_C_o_r_e) : Describe method

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

     _d_i_s_c_a_r_d_s._w_t<-(_F_L_C_o_r_e) : Describe method

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

     _d_i_s_c_a_r_d_s._w_t<-(_F_L_C_o_r_e) : Describe method

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

     _d_o_t_p_l_o_t(_l_a_t_t_i_c_e) : Describe method

      ' signature(x=formula,data=FLQuant) '

     _E(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _f_e_c<-(_F_L_C_o_r_e) : Describe method

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

     _F_L_C_a_t_c_h(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _F_L_C_o_h_o_r_t(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _F_L_M_e_t_i_e_r(_F_L_C_o_r_e) : Describe method

      ' signature(catches=missing) '

     _F_L_Q_u_a_n_t(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _F_L_Q_u_a_n_t_P_o_i_n_t(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _F_L_S_R(_F_L_C_o_r_e) : Describe method

      ' signature(object=FLQuant,model=missing) '

     _F_L_S_R(_F_L_C_o_r_e) : Describe method

      ' signature(object=FLQuant,model=character) '

     _F_L_S_R(_F_L_C_o_r_e) : Describe method

      ' signature(object=FLQuant,model=function) '

     _F_L_S_R(_F_L_C_o_r_e) : Describe method

      ' signature(object=FLQuant,model=formula) '

     _h_a_r_v_e_s_t<-(_F_L_C_o_r_e) : Describe method

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

     _h_i_s_t_o_g_r_a_m(_l_a_t_t_i_c_e) : Describe method

      ' signature(x=formula,data=FLQuant) '

     _i_t_e_r(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _i_t_e_r<-(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing,value=missing) '

     _i_t_e_r_s(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s<-(_F_L_C_o_r_e) : Describe method

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

     _l_a_n_d_i_n_g_s<-(_F_L_C_o_r_e) : Describe method

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

     _l_a_n_d_i_n_g_s._n<-(_F_L_C_o_r_e) : Describe method

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

     _l_a_n_d_i_n_g_s._n<-(_F_L_C_o_r_e) : Describe method

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

     _l_a_n_d_i_n_g_s._w_t<-(_F_L_C_o_r_e) : Describe method

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

     _l_a_n_d_i_n_g_s._w_t<-(_F_L_C_o_r_e) : Describe method

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

     _m<-(_F_L_C_o_r_e) : Describe method

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

     _m<-(_F_L_C_o_r_e) : Describe method

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

     _n<-(_F_L_C_o_r_e) : Describe method

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

     _n_a_m_e_s(_b_a_s_e) : Describe method

      ' signature(x=missing) '

     _p_l_o_t(_g_r_a_p_h_i_c_s) : Describe method

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

     _p_r_i_c_e<-(_F_L_C_o_r_e) : Describe method

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

     _p_r_i_n_t(_b_a_s_e) : Describe method

      ' signature(x=missing) '

     _p_r_o_p_a_g_a_t_e(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _q_u_a_n_t(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _q_u_a_n_t<-(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing,value=missing) '

     _q_u_a_n_t_i_l_e(_s_t_a_t_s) : Describe method

      ' signature(x=missing) '

     _r_l_n_o_r_m(_s_t_a_t_s) : Describe method

      ' signature(n=numeric,meanlog=FLQuant,sdlog=FLQuant) '

     _r_l_n_o_r_m(_s_t_a_t_s) : Describe method

      ' signature(n=numeric,meanlog=FLQuant,sdlog=numeric) '

     _r_l_n_o_r_m(_s_t_a_t_s) : Describe method

      ' signature(n=numeric,meanlog=numeric,sdlog=FLQuant) '

     _r_n_o_r_m(_s_t_a_t_s) : Describe method

      ' signature(n=numeric,mean=FLQuant,sd=FLQuant) '

     _s_h_o_w(_m_e_t_h_o_d_s) : Describe method

      ' signature(object=missing) '

     _s_p_w_n<-(_F_L_C_o_r_e) : Describe method

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

     _s_t_r_i_p_p_l_o_t(_l_a_t_t_i_c_e) : Describe method

      ' signature(x=formula,data=FLQuant) '

     _s_u_m_m_a_r_y(_b_a_s_e) : Describe method

      ' signature(object=missing) '

     _t_r_i_m(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _u_n_i_t_s(_b_a_s_e) : Describe method

      ' signature(x=missing) '

     _u_n_i_t_s<-(_b_a_s_e) : Describe method

      ' signature(x=FLQuant,value=character) '

     _w_i_n_d_o_w(_s_t_a_t_s) : Describe method

      ' signature(x=missing) '

     _w_t<-(_F_L_C_o_r_e) : Describe method

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

     _x_y_p_l_o_t(_l_a_t_t_i_c_e) : Describe method

      ' signature(x=formula,data=FLQuant) '

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

     The FLR Team

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

     [, [<-, apply, Arith, as.data.frame, as.FLQuant, barchart,
     bubbles, bwplot, catch<-, catch.n<-, catch.wt<-, coerce, cv,
     dimnames<-, dims, discards<-, discards.n<-, discards.wt<-,
     dotplot, E, fec<-, FLCatch, FLCohort, FLMetier, FLQuant,
     FLQuantPoint, FLSR, harvest<-, histogram, iter, iter<-, iters,
     landings<-, landings.n<-, landings.wt<-, m<-, n<-, names, plot,
     price<-, print, propagate, quant, quant<-, quantile, rlnorm,
     rnorm, show, spwn<-, stripplot, summary, trim, units, units<-,
     window, wt<-, xyplot, array

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

     # creating a new FLQuant
     flq <- FLQuant(rnorm(200), dimnames=list(age=1:5, year=2000:2008), units='diff')
     summary(flq)

     flq[1,]
     flq[,1]
     flq[1,1] <- 0

     units(flq)
     quant(flq)

     xyplot(data ~ year, data=flq, type='b', main='FLQ Test Plot', groups=age,
       ylab='diff', xlab='', pch=19, auto.key=TRUE)

