importance: Identify predictive cell populations

Description Usage Arguments Value

View source: R/importance.R

Description

Identify predictive cell populations

Usage

1
2
3
4
5
6
7
8
9
importance(
  tubeset,
  flowForest,
  nOfTube = 1,
  threshold = 0.95,
  transparency = 0.1,
  sizePenalty = TRUE,
  additionalPlots = FALSE
)

Arguments

tubeset

Flow cytometry measurements, in a form of a tubeset, as that created by the function loadTubeset.

flowForest

Object of a class flowForest, trained by the function flowForest on tubeset.

nOfTube

Number of tube in tubeset on which flowForest was build; only gates on this tube will be extracted.

threshold

A vector of indices of objects in tubeset which are to be assumed to reside in the test set. By default those not in trainMask.

transparency

Transparency of events on the scatterplot produced by the function.

sizePenalty

Shall gates comprising many events be considered less important?

additionalPlots

If FALSE, only histogram of scores of events and scatterplot with important events will be printed. Otherwise, additionally barplot with frequency of usage of each criterion on gates in splits will be printed too.

Value

Data frame with coordinates of events from the tubeset (all columns except last two), it's scores of importance (the penultimate column) and logical vector indicating, if they were considered as important or not (the last column).


flowforest/flowforest documentation built on April 14, 2020, 4:41 a.m.