attachBgrd-methods            package:xps            R Documentation

_A_t_t_a_c_h/_R_e_m_o_v_e _B_a_c_k_g_r_o_u_n_d _I_n_t_e_n_s_i_t_i_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Attach/remove background intensities to/from 'DataTreeSet'.

     _Usage_

     'attachBgrd(object, treenames = "*")'

     'removeBgrd(object)'

_A_r_g_u_m_e_n_t_s:

  object: Object of class '"DataTreeSet"'.

treenames: Object of class '"list"' representing the names of the 
          'ROOT' background trees.

_D_e_t_a_i_l_s:

     Whenever one of the 'bgcorrect' methods will be applied to raw CEL
     intensities, the background intensities will be stored in 'ROOT'
     background trees. However, the background intensities will not be
     saved as data.frame 'bgrd', thus avoiding memory problems.
     Function 'attachBgrd' allows to fill slot 'bgrd' on demand.

     'attachBgrd' exports intensities from background trees from 'ROOT'
     data file and saves as data.frame 'bgrd'. 'treenames' is a vector
     of tree names to attach; for 'treenames="*"' all trees from slot
     'treenames' will be exported and background intensities attached
     as data.frame 'bgrd'.

     'removeBgrd' removes background intensities from 'DataTreeSet' and
     replaces data.frame 'bgrd' with an empty data.frame of dim(0,0).

_V_a_l_u_e:

     A 'DataTreeSet' object.

_N_o_t_e:

     Do not use 'attachBgrd' unless you know that your computer has
     sufficient RAM, especially when using exon arrays. It may be
     advisible to use a subset of 'treenames' only.

_A_u_t_h_o_r(_s):

     Christian Stratowa

_S_e_e _A_l_s_o:

     'attachInten', 'removeInten'

