cimage.cell.image: cimage.cell.image

View source: R/cimage.R

cimage.cell.imageR Documentation

cimage.cell.image

Description

returns cropped cell images arranged in some way

Usage

## S3 method for class 'cell.image'
cimage(
  X,
  formula = NULL,
  subset = NULL,
  facets = NULL,
  scales = "fixed",
  allow.expressions = FALSE,
  nx = NULL,
  ny = NULL,
  facets.nx = NULL,
  facets.ny = NULL,
  bg.col = "white",
  border = 1,
  facets.border = 1,
  rev.y = TRUE,
  font.size = 14,
  font.col = "black",
  display = interactive(),
  ...
)

Arguments

X

cell.data or cell.image object to plot

formula

formula of the form 'var1+var2~var3' specifying how the images are to be ordered. See details.

subset

logical expression indicating elements or rows to keep. Don't specify channel here

facets

formula of the form 'var1+var2~var3' specifying how to facet the plot. See details.

scales

either 'none', 'fixed' or 'free' axis for each facet

allow.expressions

allow expressions in formulas, set to TRUE when called from cimage.cell.data

nx

number of columns of images within each facet. Used with formula '~var1' or 'var1~.'

ny

number of rows of images within each facet. Used with formulas '~var1' or 'var1~.'

facets.nx

number of columns of facets. Used with facets '~var1' or 'var1~.'

facets.ny

number of rows of facets. Used with facets '~var1' or 'var1~.'

bg.col

The background color of the plot

border

the width in pixels of the border between images

facets.border

the width in pixels of the border between facets

rev.y

boolean indicating if the y axis should be reversed

font.size

The size of the font to use, in pixels

font.col

The color of the font to use

display

boolean indicating if the created image should be displayed

...

further arguments for methods. cimage calls get_cell_image, so all the arguments of this function are available.


gerbeldo/tidycell documentation built on Aug. 15, 2022, 2:35 p.m.