valueTags               package:Hmisc               R Documentation

_S_t_o_r_e _D_i_s_c_r_i_p_t_i_v_e _I_n_f_o_r_m_a_t_i_o_n _A_b_o_u_t _a_n _O_b_j_e_c_t

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

     Functions get or set useful information about the contents of the
     object for later use.

_U_s_a_g_e:

     valueTags(x)
     valueTags(x) <- value

     valueLabel(x)
     valueLabel(x) <- value

     valueName(x)
     valueName(x) <- value

     valueUnit(x)
     valueUnit(x) <- value

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

       x: an object 

   value: for 'valueTags<-' a named list of value tags. a character
          vector of length 1, or 'NULL'. 

_D_e_t_a_i_l_s:

     These functions store the a short name of for the contents, a
     longer label that is useful for display, and the units of the
     contents that is useful for display.

     'valueTag' is an accessor, and 'valueTag<-' is a replacement
     function for all of the value's information.

     'valueName' is an accessor, and 'valueName<-' is a replacement
     function for the value's name.  This name is used when a plot or a
     latex table needs a short name and the variable name is not
     useful.

     'valueLabel' is an accessor, and 'valueLabel<-' is a replacement
     function for the value's label.  The label is used in a plots or
     latex tables when they need a descriptive name.

     'valueUnit' is an accessor, and 'valueUnit<-' is a replacement
     function for the value's unit.  The unit is used to add unit
     information to the R output.

_V_a_l_u_e:

     'valueTag' returns 'NULL' or a named list with each of the named
     values 'name', 'label', 'unit' set if they exists in the object.

     For 'valueTag<-' returns 'list'

     For 'valueName', 'valueLable', and 'valueUnit'  returns 'NULL' or
     character vector of length 1.

     For 'valueName<-', 'valueLabel<-', and 'valueUnit' returns 'value'

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

     Charles Dupont

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

     'names', 'attributes'

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

     age <- c(21,65,43)
     y   <- 1:3
     valueLabel(age) <- "Age in Years"
     plot(age, y, xlab=valueLabel(age))

     x1 <- 1:10
     x2 <- 10:1
     valueLabel(x2) <- 'Label for x2'
     valueUnit(x2) <- 'mmHg'
     x2
     x2[1:5]
     dframe <- data.frame(x1, x2)
     Label(dframe)

     ##In these examples of llist, note that labels are printed after
     ##variable names, because of print.labelled
     a <- 1:3
     b <- 4:6
     valueLabel(b) <- 'B Label'

