report               package:ShortRead               R Documentation

_S_u_m_m_a_r_i_z_e _q_u_a_l_i_t_y _a_s_s_e_s_s_m_e_n_t _r_e_s_u_l_t_s _i_n_t_o _a _r_e_p_o_r_t

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

     This generic function summarizes results from evaluation of 'qa'
     into a report. Available report formats vary depending on the data
     analysed.

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

     report(x, ..., dest = tempfile(), type = "pdf")

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

       x: An object returned by 'qa', usually derived from class '.QA'

     ...: Additional arguments used by specific methods. See specific
          methods for details.

    dest: The output destination for the final report; destination
          files are overwritten if they already exist.

    type: A text string defining the type of report; available report
          types depend on the type of object 'x'.

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

     The following methods are defined:

    '_d_i_r_P_a_t_h="_c_h_a_r_a_c_t_e_r", ..., _d_e_s_t=_t_e_m_p_f_i_l_e(), _t_y_p_e="_p_d_f"'  This
        method is used internally

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

     This function is invoked for its side effect;  the return value is
     the name of the directory or file where the report was created.

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

     Martin Morgan <mtmorgan@fhcrc.org>

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

     'SolexaExportQA'

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

     showMethods("report")

