qaProcessFrame-class          package:flowQ          R Documentation

_C_l_a_s_s "_q_a_P_r_o_c_e_s_s_F_r_a_m_e"

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

     Abstraction of subitems within a qQA process

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

     This class bundles graphs and aggregators for a single
     'flowFrame'. This allows to create processes with subcomponents,
     where each item in the 'frameAggregators' and 'frameGraphs' lists
     corresponds to one subprocess, which can be used, for instance, to
     create individual plots for each flow channel. For QA processes
     without subcomponents, these slots would simply not be populated.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects should be created using the constructor:

     'qaProcessFrame(frameID, summaryAggregator, summaryGraph,
     frameAggregators, frameGraphs, details)' where 'frameID' is the ID
     of the flowFrame the process is linked to, 'summaryAggregator' is
     an object inheriting from class 'qaAggregator' which summarizes
     the outcome, 'summaryGraph' is an object of class 'qaGraph' which
     is the overview graph of the process for the whole frame,
     'details' is a list containing any additional information
     regarding the QA process, 'frameAggregators' is an object of class
     'aggregatorList' and 'frameGraphs' is an object of class
     'qaGraphList'. The latter two are the collections of aggregators
     and graphs for each subprocess. Only 'frameID' and
     'summaryAggregator' are mandatory arguments.

_S_l_o_t_s:


     '_i_d': Object of class '"character"', a unique ID of the object

     '_f_r_a_m_e_I_D': Object of class '"character"', ID of the flowFrame the
          process is linked to 

     '_s_u_m_m_a_r_y_A_g_g_r_e_g_a_t_o_r': Object of class '"qaAggregator"', an
          aggregator summarizing the output of the process 

     '_s_u_m_m_a_r_y_G_r_a_p_h': Object of class '"qaGraph"', a graphical summary
          of the process 

     '_f_r_a_m_e_A_g_g_r_e_g_a_t_o_r_s': Object of class '"aggregatorList"'  a list of
          aggregators for the subprocesses

     '_f_r_a_m_e_G_r_a_p_h_s': Object of class '"qaGraphList"' a list of graphical
          summaries for the subprocesses 

     '_d_e_t_a_i_l_s': A list for any additional information 

_M_e_t_h_o_d_s:



     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "qaProcessFrame")': constructor 


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

     Florian Hahne

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

     'qaGraphList', 'writeQAReport', 'qaProcess'

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

     showClass("qaProcessFrame")

