Skip to content

Commit

Permalink
clarify the second argument in autoplot RGLab/flowWorkspace#248
Browse files Browse the repository at this point in the history
  • Loading branch information
mikejiang committed Apr 3, 2018
1 parent 4676b61 commit 9d28ac4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion R/autoplot.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
#'
#' Overloaded autoplot for the cytomertry data structure: flowFrame or flowSet, Gatinghierarchy, GatingSet.
#' It plots the cytometry data with geom_histogram, geom_density or geom_hex.
#' When autoplot a GatingSet/Gatinghierarchy, the second argument should be a gate or population node. And the dimensions(channels/markers) are deduced from the gate dimensions.
#'
#' @param object flowFrame, flowSet, GatingSet object
#' @param x define the x dimension of the plot. When object is a flowFrame, it can be missing, which plots 1d density plot on all the channels.
#' @param x define the x dimension of the plot (not used when object is a GatingSet). When object is a flowFrame, it can be missing, which plots 1d density plot on all the channels.
#' @param y define the y dimension of the plot. Default is NULL, which means 1d densityplot.
#' @param bins passed to geom_hex
#' @param axis_inverse_trans logical flag indicating whether to add \link{axis_x_inverse_trans} and axis_x_inverse_trans layers.
Expand Down
3 changes: 2 additions & 1 deletion man/autoplot.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 9d28ac4

Please sign in to comment.