split,flowClust-method       package:flowClust       R Documentation

_S_p_l_i_t_t_i_n_g _D_a_t_a _B_a_s_e_d _o_n _C_l_u_s_t_e_r_i_n_g _R_e_s_u_l_t_s

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

     This method splits data according to results of the clustering
     (filtering) operation.  Outliers identified will be removed by
     default.

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

     ## S4 method for signature 'ANY, flowClust':
     split(x, f, split, select, rm.outliers=TRUE)

     ## S4 method for signature 'flowFrame, tmixFilterResult':
     split(x, f, split, select, rm.outliers=TRUE)

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

       x: A numeric vector, matrix, data frame of observations, or
          object of class 'flowFrame'.  This is the object on which
          'flowClust' or 'filter' was performed.

       f: Object returned from 'flowClust' or 'filter'.

   split: An optional argument which specifies how to split the data. 
          If specified, it takes a list object with named or unnamed
          elements each of which is a numeric vector specifying which
          clusters are included.  When this argument is missing, the
          data object will be split into 'K' subsets each of which is
          formed by one out of the 'K' clusters used to model the data.
           See examples for more details.

  select: An optional argument which facilitates the selection of
          columns.  If specified, it either takes a numeric (not
          supported when 'x' is of class 'flowFrame') or character
          vector.

rm.outliers: A logical value indicating whether outliers will be
          removed or not.

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

     A list object with elements each of which is a subset of 'x' and
     also retains the same class as 'x'.  If the 'split' argument is
     specified with a list of named elements, those names will be used
     to name the corresponding elements in the resultant list object.

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

     Raphael Gottardo <raph@stat.ubc.ca>, Kenneth Lo <c.lo@stat.ubc.ca>

_R_e_f_e_r_e_n_c_e_s:

     Lo, K., Brinkman, R. R. and Gottardo, R. (2008) Automated Gating
     of Flow Cytometry Data via Robust Model-based Clustering.
     _Cytometry A_ *73*, 321-332.

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

     'Subset', 'flowClust', 'filter'

