readCytoSet              package:prada              R Documentation

_C_r_e_a_t_e _a _c_y_t_o_S_e_t _o_b_j_e_c_t _f_r_o_m _o_n_e _o_r _m_o_r_e _F_C_S _3._0 _f_i_l_e_s

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

     Create a cytoSet object from one or more FCS 3.0 files

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

       readCytoSet(files=NULL, path=".", pattern=NULL, phenoData, sep="\t", ...)

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

   files: Optional character vector with filenames

    path: Directory where to look for the files

 pattern: This argument is passed on to 'dir' (see details). 

phenoData: Either an object of class 'phenoData' or of 'character'.

     ...: Further arguments that get passed on to 'read.phenoData', see
          details.

     sep: Separator character that gets passed on to function
          'read.phenoData'.

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

     There are three different ways to specify the file names:

     First, if the argument 'phenoData' is present, then it is obtained
     from its column 'name'. The column is mandatory, and an error will
     be generated if it is not there. The argument 'phenoData' can
     either be of class 'phenoData', in which case it is taken
     directly, or of class 'character', in which case this function
     tries to read a 'phenoData' object from the file with that name by
      calling 'read.phenoData(file.path(path, phenoData), ...)'.

     Second, if the argument 'phenoData' is not present and the
     argument 'files' is not 'NULL', then 'files' is expected to be a
     character vector with the file names.

     Third, if neither the argument 'phenoData' is present nor 'files'
     is not 'NULL', then the file names are obtained by calling  
     'dir(path, pattern)'.

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

     An object of class 'cytoSet'.

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

     Wolfgang Huber <URL: http://www.dkfz.de/abt0840/whuber>

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

     'readFCSdata'

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

     ## Please see man page for cytoSet-class

