Skip to contents

Create a userm object

Source: R/CreateUserm.R
CreateUserm.Rd

This function initializes a userm object (Userm) based on an unmixing matrix A. It validates the structure of A, assigns default fluor names if missing, and prepares placeholders for storing results, scaling parameters, and intensity values.

Usage

CreateUserm(A)

Arguments

A

A numeric unmixing matrix (detectors × fluors), typically extracted from a single-stained control (SCC) FCS file. Row names should represent detector channels, and column names should represent fluorophores.

Value

A list representing the userm object, containing:

  • A: the input unmixing matrix.

  • detectors: vector of detector names.

  • fluors: vector of fluorophore names.

  • Res: a named list to store res objects for each fluor.

  • Scale_df: a data frame for storing scaling parameters (min, max, scale, cofactor).

  • Intensity_mtx: a data frame for storing default intensity values.

Examples

if (FALSE) { # \dontrun{
A <- matrix(runif(20), nrow = 4, ncol = 5)
rownames(A) <- paste0("D", 1:4)
colnames(A) <- paste0("F", 1:5)
Userm <- CreateUserm(A)
} # }