buildRegion: IFC Region Coercion

View source: R/buildRegion.R

buildRegionR Documentation

IFC Region Coercion

Description

Helper to build a list to allow region export.

Usage

buildRegion(
  type,
  label,
  cx,
  cy,
  color,
  lightcolor,
  ismarker = "false",
  doesnotoverride = "false",
  xlogrange,
  ylogrange,
  x,
  y,
  ...
)

Arguments

type

Region's type. Either "line", "rect", "poly" or "oval".

label

label of the region.

cx

x label's position. If not provided x center will be used.

cy

y label's position. If not provided y center will be used.

color

color of the region. See paletteIFC for allowed colors.

lightcolor

lightcolor of the region. See paletteIFC for allowed colors.

ismarker

Default is 'false'. Allowed are 'true' or 'false'. Used for compatibility with amnis file but role remains unknown.

doesnotoverride

Default is 'false'. Allowed are 'true' or 'false'. Used for compatibility with amnis file but role remains unknown.

xlogrange

determines transformation instruction for x-axis. Default is "P" for no transformation.

ylogrange

determines transformation instruction for y-axis. Default is "P" for no transformation.

x

vector of x vertices values.

y

vector of y vertices values.

...

Other arguments to be passed.

Value

a list containing all region information.


IFC documentation built on Sept. 14, 2023, 1:08 a.m.