getControlData             package:lumi             R Documentation

_G_e_t _c_o_n_t_r_o_l _p_r_o_b_e _i_n_f_o_r_m_a_t_i_o_n

_D_e_s_c_r_i_p_t_i_o_n:

     Get control probe information from Bead Studio output or a
     LumiBatch object.

_U_s_a_g_e:

     getControlData(x, type = c('data.frame', 'LumiBatch'), ...)

_A_r_g_u_m_e_n_t_s:

       x: the control data can be a LumiBatch object or the Control
          Probe Profile file outputted by BeadStudio 

    type: determine the return data type 

     ...: other parameters used by 'lumiR' function 

_V_a_l_u_e:

     By default, it returns a data.frame with first two columns as
     "controlType" and "ProbeID". The rest columns are the expression
     amplitudes for individual samples. When type is 'LumiBatch', it
     returns a LumiBatch object, which basically is the return of lumiR
     without combining duplicated TargetIDs. As the return is a
     LumiBatch object, it includes more information, like probe number,
     detection p-value and standard error of the measurement.

_A_u_t_h_o_r(_s):

     Pan Du

_S_e_e _A_l_s_o:

     'addControlData2lumi'

_E_x_a_m_p_l_e_s:

             controlFile <- system.file('doc', 'Control_Probe_Profile.txt', package='lumi')
             ## return a data.frame
             controlData <- getControlData(controlFile)
             class(controlData)
             names(controlData)
             
             ## return a LumiBatch object
             controlData <- getControlData(controlFile, type='LumiBatch')
             summary(controlData)

