getFlowJoSummary         package:flowFlowJo         R Documentation

_S_u_m_m_a_r_i_z_e _F_l_o_w_J_o _W_o_r_k_s_p_a_c_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Makes a table of the number and count of various gates, possibly
     broken out by FCS file in one or more FlowJo workspaces.

_U_s_a_g_e:

     getFlowJoSummary(x, gatesByFile=TRUE, fileNamePatterns=".", ...)

_A_r_g_u_m_e_n_t_s:

       x: a flowJoList or flowJoObj 

gatesByFile: a boolean.  If TRUE (default) then the count of each gate
          type will be broken out for each referenced FCS file. 
          Otherwise this method will just return a table with the total
          counts of each named gate listed in the FlowJo workspace(s). 

fileNamePatterns: A list of patterns for picking out specific FCS
          files.  Default = "."  (ie. examines all of the FCS files) 

     ...: Additional arguments: to simplifyGateNames such as
          stripFileName and removeParentalNames 

_V_a_l_u_e:

     The method getFlowJoSummary returns a table summarizing the number
     of gates listed in the referenced FlowJo workspaces.  This
     function is useful for ensuring that the  cytometrist has used a
     consistent set of names in their process.

_A_u_t_h_o_r(_s):

     John Gosink

_R_e_f_e_r_e_n_c_e_s:

     See also FlowJo from Treestar Inc, at:  <URL:
     http://www.flowjo.com/>

_E_x_a_m_p_l_e_s:

     demoLocation <- system.file("extdata", "DemoWorkspace.wsp", package="flowFlowJo"); 
     actualFCSLoc <- system.file("extdata/fcsFiles", package="flowFlowJo"); 
     testList     <- readFlowJoList(demoLocation, altFileLocation=actualFCSLoc);

     getFlowJoSummary(testList, gatesByFile=FALSE, removeParentalNames=TRUE);

