hist,flowClust-method       package:flowClust       R Documentation

_1-_D _D_e_n_s_i_t_y _P_l_o_t (_H_i_s_t_o_g_r_a_m) _o_f _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 generates a one-dimensional density plot for the
     specified dimension (variable) based on the robust model-based
     clustering results.  A histogram of the actual data or cluster
     assignment is optional for display.

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

     ## S4 method for signature 'flowClust':
     hist(x, data=NULL, subset=1, include=1:(x@K), histogram=TRUE, 
          labels=TRUE, xlim=NULL, ylim=NULL, xlab=NULL, ylab="Density", 
          main=NULL, breaks=50, col=NULL, pch=20, cex=0.6, ...)

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

       x: Object returned from 'flowClust' or from running 'filter' on
          a 'flowFrame' object.

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

  subset: An integer indicating which variable is selected for the
          plot.  Alternatively, a character string containing the name
          of the variable is allowed if 'x@varNames' is not 'NULL'.

 include: A numeric vector specifying which clusters are shown on the
          plot.  By default, all clusters are included.

histogram: A logical value indicating whether a histogram of the actual
          data is made in addition to the density plot or not.

  labels: A logical value indicating whether information about cluster
          assignment is shown or not.

    xlim: The range of x-values for the plot.  If 'NULL', the data
          range will be used.

    ylim: The range of y-values for the plot.  If 'NULL', an optimal
          range will be determined automatically.

xlab, ylab: Labels for the x- and y-axes respectively.

    main: Title of the plot.

  breaks: Content to be passed to the 'breaks' argument of the generic
          'hist' function, if 'histogram' is 'TRUE'.  Default is 50,
          meaning that 50 vertical bars with equal binwidths will be
          drawn.

     col: Colors of the plotting characters displaying the cluster
          assignment (if 'labels' is 'TRUE').  If 'NULL' (default), it
          will be determined automatically.

     pch: Plotting character used to show the cluster assignment.

     cex: Size of the plotting character showing the cluster
          assignment.

     ...: Further arguments passed to 'curve' (and also 'hist' if
          'histogram' is 'TRUE').

_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:

     'flowClust', 'plot', 'density'

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

     res <- flowClust(iris[,1:4], K=3)
     hist(res, data=iris, subset="Petal.Length", breaks=30)
     hist(res, data=iris, subset=3, histogram=FALSE, labels=FALSE)
     hist(res, data=iris, subset="Petal.Length", breaks=30, include=2:3)

