ExperimentPath-class        package:ShortRead        R Documentation

"_E_x_p_e_r_i_m_e_n_t_P_a_t_h" _c_l_a_s_s _r_e_p_r_e_s_e_n_t_i_n_g _a _f_i_l_e _h_i_e_r_a_r_c_h_y _o_f _d_a_t_a
_f_i_l_e_s

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

     Short read technologies often produce a hierarchy of output files.
     The content of the hierarchy varies. This class represents the
     root of the file hierarchy. Specific classes (e.g., 'SolexaPath')
     represent different technologies.

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

     Objects from the class are created by calls to the constructor:

     'ExperimentPath(experimentPath)'


     _e_x_p_e_r_i_m_e_n_t_P_a_t_h 'character(1)' object pointing to the top-level
          directory of the experiment; see specific technology classes
          for additional detail.

     _v_e_r_b_o_s_e=_F_A_L_S_E (optional) logical vector which, when 'TRUE' results
          in warnings if paths do not exist.

     All paths must be fully-specified.

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

     'ExperimentPath' has one slot, containing a fully specified path
     to the corresponding directory (described above).

     '_b_a_s_e_P_a_t_h' See above.

     The slot is accessed with 'experimentPath'.

_E_x_t_e_n_d_s:

     Class '".ShortReadBase"', directly.

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

     Methods include:


     _s_h_o_w 'signature(object = "ExperimentPath")': briefly summarize the
          file paths of 'object'.

     _d_e_t_a_i_l 'signature(object = "ExperimentPath")': summarize file
          paths of 'object'.

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

     Michael Lawrence

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

     showClass("ExperimentPath")

