addCumulative-methods: Add cumulative values to the assays

In steveped/incucyteR: Process Incucyte Growth Curve Data

Description

Add assays with cumulative values to an IncucyteExperiment

Usage

addCumulative(
  x,
  assay,
  name,
  allowDecrease = FALSE,
  suffix = "cumulative",
  sep = "_"
)

## S4 method for signature 'ANY'
addCumulative(
  x,
  assay,
  name,
  allowDecrease = FALSE,
  suffix = "cumulative",
  sep = "_"
)

## S4 method for signature 'IncucyteExperiment'
addCumulative(
  x,
  assay,
  name,
  allowDecrease = FALSE,
  suffix = "cumulative",
  sep = "_"
)

Arguments

x	An IncucyteExpeiment object
assay	The assays for which a cumulative sum is required. Defaults to all existing assays
name	Names to give to the new (cumulative) assays
allowDecrease	logical vector. Allows the cumulative sum to decrease. For counts of dead cells, allowing a decrease may not be appropriate as dead cells cannot revive. However, for growth assays this may be more relevant
suffix	If the name argument is not provided, this suffix will be added to the original assay name
sep	Text separator use to separate the assay name and the suffix

Details

After specifying which assays, this calculates a cumulative sum of the values in each requested assay. This may be useful as assays which measure death are inherently transient, whilst those which measure growth are implicitly cumulative

Value

An IncucyteExperiment object

steveped/incucyteR documentation built on Sept. 7, 2020, 12:22 p.m.