getClusterNames: Obtain valid cluster names

Description Usage Arguments Value

View source: R/get-family.R

Description

Returns all valid cluster names that can be used as input for the across-argument.

Usage

1
getClusterNames(object, phase = "first_tmt", algorithm_subset = NULL)

Arguments

object

A valid cell tracer object.

phase

Character value. Refers to the phase of the experiment. Valid inputs are:

'before_tmt'

Uses the data that refers to the time before the treatment.

'first_tmt'

Uses the data that refers tot the time after the treatment.

Note: This argument is ignored if the experiment set up did not include any treatment or the treatment started right from the beginning.

algorithm_subset

Character value or NULL. If character only the cluster names of the algorithms denoted are returned.

Value

A list named according to all cluster algorithms found. Each named slot contains a character vector of all cluster names of the algorithm.


kueckelj/celltracer documentation built on June 2, 2021, 6:37 a.m.