ZPRIMEQualControl          package:RNAither          R Documentation

_C_o_m_p_u_t_i_n_g _t_h_e _Z' _f_a_c_t_o_r

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

     Computes the Z' factor per plate for a complete dataset file and
     plots the results.

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

     ZPRIMEQualControl(header, data, channel, plotTitle, showPlot)

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

  header: the header of a dataset file generated with
          'generateDatasetFile' 

    data: an R data frame generated with 'generateDatasetFile' 

 channel: a character string specifying the name of the column
          containing the values for computing the Z' factor, e.g.
          '"SigIntensity"' 

plotTitle: the plot title 

showPlot: 0 or 1. 1 will open one or several plot windows in the R GUI,
          0 will only save the plot(s) without opening windows. 

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

     Returns the Z' values in the shell for each plate and saves them
     in a text file. The name of the text file will be the
     concatenation of the experiment name specified in the header and
     the character string "Z'Scores.txt".

     Shows a plot of the Z' factor values and saves it as a png and a
     pdf file under the experiment name specified in the header
     concatenated with the function argument ' plotTitle'.

     The function returns a list containing:

plotName : the plot name

ZPrimeTabelle : table containing the Z' values

_R_e_f_e_r_e_n_c_e_s:

     J. Zhang, T. Chung, and K. Oldenburg. A simple statistical
     parameter for use in evaluation and validation of high throughput
     screening assays. J Biomol Screen, 4:67-73, 1999.

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

     data(exampleHeader, package="RNAither")
     data(exampleDataset, package="RNAither")

     res <- ZPRIMEQualControl(header, dataset, "SigIntensity", "Z' factors per plate", 1)
     zprime_plot <- res[[1]]
     zprime_table <- res[[2]]

