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'

