cyto_plot_point: Add points and contour lines to empty cyto_plot

View source: R/cyto_plot_point.R

cyto_plot_pointR Documentation

Add points and contour lines to empty cyto_plot

Description

Add points and contour lines to empty cyto_plot

Usage

cyto_plot_point(x, ...)

## S3 method for class 'flowFrame'
cyto_plot_point(
  x,
  channels,
  overlay = NA,
  display = 1,
  point_shape = ".",
  point_size = 2,
  point_col_scale = NA,
  point_cols = NA,
  point_col = NA,
  point_col_alpha = 1,
  contour_lines = 0,
  contour_line_type = 1,
  contour_line_width = 1,
  contour_line_col = "black",
  contour_line_alpha = 1,
  ...
)

## S3 method for class 'list'
cyto_plot_point(
  x,
  channels,
  display = 1,
  point_shape = ".",
  point_size = 2,
  point_col_scale = NA,
  point_cols = NA,
  point_col = NA,
  point_col_alpha = 1,
  contour_lines = 0,
  contour_line_type = 1,
  contour_line_width = 1,
  contour_line_col = "black",
  contour_line_alpha = 1,
  ...
)

Arguments

x

object of class flowFrame or a list of flowFrame onjects.

...

not in use.

channels

names of the channels used to construct the plot.

overlay

optional argument if x is a flowFrame to overlay a list of flowFrame objects.

display

controls the number or percentage of events to display, set to 1 by default to display all events.

point_shape

shape(s) to use for points in 2-D scatterplots, set to "." by default to maximise plotting speed. See pch for alternatives.

point_size

numeric to control the size of points in 2-D scatter plots set to 2 by default.

point_col_scale

vector of ordered colours to use for the density colour gradient of points.

point_cols

vector colours to draw from when selecting colours for points if none are supplied to point_col.

point_col

colour(s) to use for points in 2-D scatter plots, set to NA by default to use a blue-red density colour scale.

point_col_alpha

numeric [0,1] to control point colour transparency in 2-D scatter plots, set to 1 by default to use solid colours.

contour_lines

numeric indicating the number of levels to use for contour lines, set to 0 by default to exclude contour lines.

contour_line_type

type of line to use for contour lines, set to 1 by default.

contour_line_width

line width for contour lines, set to 2 by default.

contour_line_col

colour to use for contour lines, set to "black" by default.

contour_line_alpha

numeric [0,1] to control transparency of contour lines, set to 1 by default to remove transparency.

Author(s)

Dillon Hammill, Dillon.Hammill@anu.edu.au


DillonHammill/CytoExploreR documentation built on March 2, 2023, 7:34 a.m.