units                 package:FLCore                 R Documentation

_u_n_i_t_s _a_t_t_r_i_b_u_t_e _f_o_r _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:

     Objects of class 'FLQuant' contain an 'units' attribute of class 
     'character'. This should be used to store the corresponding units
     of measurement. This attribute can be directly accessed and
     modified using the 'units' and  'units<-' methods.

     For complex objects, 'units' will return a named list containing
     the attributes of all 'FLQuant' slots. 'units' of a complex object
     can be modified for all slots or a subset of them, by passing a
     named list with the new values. See examples below.

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

     units(x) 

     units<-(x,value)

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


      _s_i_g_n_a_t_u_r_e(_x=_F_L_Q_u_a_n_t) : Describe method

      _s_i_g_n_a_t_u_r_e(_x=_F_L_C_o_m_p) : Describe method

      _s_i_g_n_a_t_u_r_e(_x=_F_L_P_a_r) : Describe method

      _s_i_g_n_a_t_u_r_e(_x=_F_L_C_o_h_o_r_t) : Describe method

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

     The FLR Team

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

     FLQuant-class, FLPar-class, FLCohort-class

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

     flq <- FLQuant(rnorm(100), dim=c(5,20), units='kg')
     units(flq)
     units(flq) <- 't'
     summary(flq)

     # units for a complex object
     data(ple4)
     units(ple4)
     units(ple4) <- list(harvest='hr')

