R/scales_flowJo_biexp.R

In RGLab/ggcyto: Visualize Cytometry data with ggplot

#' Add a flowJo biexponential scale to the x or y axes of a ggcyto plot.
#' 
#' @name scales_flowjo_biexp
#' @aliases scale_x_flowjo_biexp scale_y_flowjo_biexp
#' scale_x_flowJo_biexp scale_y_flowJo_biexp
#' @param ... common continuous scale parameters passed to 'continuous_scale' (not used currently)
#' @param maxValue,widthBasis,pos,neg see 'help(flowjo_biexp')
#' @param equal.space whether to display the breaks in equal.space format
#' @return ScaleContinuous object
#' @importFrom flowWorkspace flowjo_biexp_trans
#' @examples 
#' data(GvHD)
#' fr <- GvHD[[1]]
#' p <- ggcyto(fr, aes(x = `FL1-H`)) + geom_density()
#' #display at raw scale
#' p 
#' #display at transformed scale
#' p + scale_x_flowjo_biexp(maxValue = 1e4, widthBasis = 0)
#' @export
scale_x_flowjo_biexp <- function(..., maxValue = 262144, widthBasis = -10, pos = 4.5, neg = 0, equal.space = FALSE){
  myTrans <- flowjo_biexp_trans(maxValue = maxValue, widthBasis = widthBasis, pos = pos, neg = neg, equal.space = equal.space)
  scale_x_continuous(..., trans = myTrans)
}

#' @export
scale_x_flowJo_biexp <- function(...){
  .Deprecated("scale_x_flowjo_biexp")
  scale_x_flowjo_biexp(...)
}

#' @rdname scales_flowjo_biexp
#' @export
scale_y_flowjo_biexp <- function(..., maxValue = 262144, widthBasis = -10, pos = 4.5, neg = 0, equal.space = FALSE){
  myTrans <- flowjo_biexp_trans(maxValue = maxValue, widthBasis = widthBasis, pos = pos, neg = neg, equal.space = equal.space)
  scale_y_continuous(..., trans = myTrans)
}

#' @export
scale_y_flowJo_biexp <- function(...){
  .Deprecated("scale_x_flowjo_biexp")
  scale_x_flowjo_biexp(...)
}