spherize: Spherize data.

View source: R/spherize.R

spherizeR Documentation

Spherize data.

Description

spherize transforms specified observation variables by estimating a sphering transformation on a sample and applying it to the population.

Usage

spherize(population, variables, sample, regularization_param = 1)

Arguments

population

tbl with grouping (metadata) and observation variables.

variables

character vector specifying observation variables.

sample

tbl containing sample that is used by the method to estimate sphering parameters. sample has same structure as population. Typically, sample corresponds to controls in the experiment.

regularization_param

optional parameter used in sphering to offset eigenvalues to avoid division by zero.

Value

transformed data of the same class as population.

Examples

population <- tibble::tibble(
  Metadata_Well = c("A01", "A02", "B01", "B02"),
  Intensity_DNA = c(8, 20, 12, 32),
  Texture_DNA = c(5, 2, 43, 13)
)
variables <- c("Intensity_DNA", "Texture_DNA")
spherize(population, variables, population, 0.01)

CellProfiler/cytominr documentation built on July 2, 2023, 6:19 p.m.