createCompensation: Create compensation

In primitybio/cellengine-r-toolkit: 'CellEngine' API Toolkit

Create compensation

Description

Creates a new compensation.

Usage

createCompensation(experimentId, name, spillMatrix, channels = NULL)

Arguments

experimentId	The ID of the experiment of a byName expression.
name	Name of the compensation matrix.
spillMatrix	The spillover matrix. This can either be a 1-dimensional vector of size length(channels) ^ 2, or a matrix.
channels	The channel names. Not required if spillMatrix is a matrix with dimnames set.

Examples

## Not run: 
createCompensation(
  experimentId,
  name="Comp 1",
  channels=c("Ax488-A", "PE-A"),
  spillMatrix=c(1, 0,
                0, 1)
)
# same as:
createCompensation(
  experimentId,
  name="Comp 1",
  spillMatrix=matrix(
    c(1, 0,
      0, 1),
    nrow=2,
    ncol=2,
    byrow=TRUE,
    dimnames=list(c("Ax488-A", "PE-A"), c("Ax488-A", "PE-A"))
  )
)

## End(Not run)

primitybio/cellengine-r-toolkit documentation built on Oct. 19, 2024, 1:17 a.m.