positivity_thresholds: Positivity Thresholds

Description Usage Arguments Value

View source: R/fluster_methods.R

Description

Given a (high resolution) clustering, calculate, for each marker, the median and spread of each cluster. Then, identify the most negative and most positive (and also tight) clusters. The positivity threshold will be between them, closer to the tighter of the two.

We prioritize tight clusters over diffuse clusters by computing a figure of merit, which is the normalized median value divided by the spread.

NOTE: One of fluster_obj or ff must not be null. If fluster_obj is null, then it is calculated from ff. If fluster_obj is not null, and its internal fcs object also isn't null, it is used as ff, and the ff argument is ignored.

ALSO NOTE: This function internally de-rails and de-negs the data so that the kernel density estimates are not confused by rail or excessivley negative events. This is an experimental feature.

Usage

1
2
3
4
5
6
7
8
positivity_thresholds(
  fluster_obj = NULL,
  fcs = NULL,
  parameters = NULL,
  manual_thresholds = NULL,
  show = FALSE,
  show_range = NULL
)

Arguments

fluster_obj

An existing fluster object, the result of running fluster().

fcs

A flowFrame or flowSet.

parameters

The parameters you wish to consider.

manual_thresholds

A named vector of one or more values that will override the internally-calculated positivity thresholds.

show

Logical. Should we display the result graphically?

show_range

The range of values to include in calculating the kernel density estimates.

Value

A fluster object that includes a modality slot.


rogerswt/fluster documentation built on July 21, 2021, 1:04 p.m.