qaReport                package:flowQ                R Documentation

_C_r_e_a_t_e _H_T_M_L _r_e_p_o_r_t _u_s_i_n_g _o_n_e _o_r _s_e_v_e_r_a_l _Q_A _p_r_o_c_e_s_s _f_u_n_c_t_i_o_n(_s)

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

     This function combines all graphical output of multiple QA process
     functions for one 'flowSet' in a single hyperlinked HTML document.

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

     qaReport(set, qaFunctions, outdir = "./qaReport", argLists, grouping =
     NULL, ...)

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

     set: A 'flowSet' 

qaFunctions: A character vector of the names of QA process functions to
          be used 

  outdir: The directory to which the HTML report is to be saved. 

argLists: lists of argument lists for each of the QA process functions
          specified via 'qaFunctions' 

grouping: A character scalar indicating a variable in the 'flowSet''s
          'phenoData' that is used as a grouping factor in the output. 

     ...: Further arguments that are passed on to 'writeQAReport'.

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

     This is a simple convenience function to produce HTML QA reports
     for a single 'flowSet' given a list of QA process functions. For
     more fine-grained control use function  'writeQAReport' directly.

     An entry point to the output of this function can be found at
     'outdir/index.html'.

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

     The function is called for it's side effects

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

     Florian Hahne

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

     'qaProcess.marginevents', 'writeQAReport', 'qaProcess',
     'qaProcess.timeline'

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

     ## Not run: 
     data(GvHD)
     GvHD <- transform(GvHD, "FL1-H"=asinh(`FL1-H`), "FL2-H"=asinh(`FL2-H`))
     dest <- tempdir()
     qaReport(GvHD, c("qaProcess.timeline", "qaProcess.marginevents"), dest,
      list(list(channel="FL1-H", cutoff=1), list(channels=c("FL1-H",
       "FL2-H"), cFactor=4)))
     browseURL(file.path(dest, "index.html"))
     ## End(Not run)

