FLQuant                package:FLCore                R Documentation

_C_r_e_a_t_e _F_L_Q_u_a_n_t _o_b_j_e_c_t_s

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

     The 'FLQuant' constructor method allows simple creation of new
     FLQuant objects from vectors, matrices and arrays.

     R standard recyling rules (row first) are applied in most cases,
     so if an input object  smaller than the required dimensions is
     given, it will be reused. An exception is made for objects of
     class vector, which will be considered to go along the second
     dimension ('year') instead of the first one. To recover the
     standard behaviour, a matrix can be created.

     The 'iter' argument takes preference over 'dim' but not over
     'dimnames', so it is preferable to ensure consistency between
     arguments. 'dim' and  'dimnames' must match and an error is thrown
     otherwise.

_A_r_g_u_m_e_n_t_s:


     _o_b_j_e_c_t An input object.

     _d_i_m The dimensions of the object. A vector of class 'numeric'.

     _d_i_m_n_a_m_e_s The dimension names, as a 'list'.

     _q_u_a_n_t A 'character' string with the name of the first dimension.
          Defaulta to 'quant'

     _u_n_i_t_s A 'character' string with the units of measurement. Defaults
          to 'NA'

     _i_t_e_r The number of iterations, i.e. the length of the sixth
          dimension, on the output object.

     _f_i_l_l._i_t_e_r TRUE

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

     FLQuant(object)

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


      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_m_i_s_s_i_n_g) : Describe method

      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_v_e_c_t_o_r) : Describe method

      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_a_r_r_a_y) : Describe method

      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_m_a_t_r_i_x) : Describe method

      _s_i_g_n_a_t_u_r_e(_o_b_j_e_c_t=_F_L_Q_u_a_n_t) : Describe method

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

     The FLR Team

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

     FLQuant-class

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

     flq <- FLQuant()
     flq <- FLQuant(1:10, dim=c(2,5))
     summary(flq)

     # Vectors are used column first...
     dim(FLQuant(1:10))
     # ...while matrices go row first.
     dim(FLQuant(matrix(1:10)))

     FLQuant(matrix(rnorm(100), ncol=20))

     FLQuant(array(rnorm(100), dim=c(5,2,1,1,1,10)))
     FLQuant(array(rnorm(100), dim=c(5,2)), iter=10)

