getAnnotation           package:beadarray           R Documentation

_S_t_o_r_a_g_e _o_f _a_n_n_o_t_a_t_i_o_n _i_n_f_o_r_m_a_t_i_o_n _f_o_r _I_l_l_u_m_i_n_a _e_x_p_r_e_s_s_i_o_n _c_h_i_p_s

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

     Illumina use several control types for QA purposes, however the
     IDs of these controls change between different organisms and
     annotation revisions. Therefore we need to store the annotation of
     a chip in order to perform QA on the bead-level data. The
     functions setAnnotation and getAnnotation are used to manage this
     annotation information.

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

     getAnnotation(BLData)
     setAnnotation(BLData, aName)

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

  BLData: BeadLevelList for an Illumina expression array.

   aName: Character to define the annotation of the chip

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

     We currently store the annotation as a slot in a BeadLevelList.
     The value in the slot should match one of entries in
     'ExpressionControlData' (see example).

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

     setAnnotation returns a modified BeadLevelList with the new value
     for the annotation slot.

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

     Mark Dunning

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

     'ExpressionControlData'

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

     data(BLData)
     data(ExpressionControlData)
     getAnnotation(BLData)
     names(ExpressionControlData)

