createTubeset: Convert a set of FCS files into a tubeset

Description Usage Arguments Value Note

View source: R/convert.R

Description

This function allows one to create a >>tubeset<< (a specific form of cytometry data on which flowForest can operate) from a set of FCS files

Usage

1
2
3
4
5
6
7
createTubeset(
  fNamesInTubes,
  dirOut,
  reduce = 1,
  removeColumns = NULL,
  verbose = FALSE
)

Arguments

fNamesInTubes

A list of character vectors; n-th element corresponds to n-th tube, its m-th element is a path to an FCS file describing m-th object

dirOut

Path to write output files; may not exist, function will try to recursively create it

reduce

Only extract random sample of reduce * 100% of events. Set to 1 to disable any manipulation

removeColumns

A numeric vector of parameter indices which should be dropped from the converted set; useful to remove nonsense data like event ID or time

verbose

Set to TRUE to enable process progress reporting

Value

Invisible NULL; the important side effect is a set of files <dirOut>/tube<N>.bin holding the converted data, which can be loaded with loadTubeset function.

Note

You don't have to create separate tubesets for training and test data; this can be specified as a mask given to the flowForest function.

Converter will overwrite existing tube<N>.bin files, yet it is adviced to use empty paths (for instance, N-tube set written over N+1-tube one will leave one old tube file, leading to either load failure or unexpected results).


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