getSTATSREPORT: Statistics Report Template Extraction
In gitdemont/IFC: Tools for Imaging Flow Cytometry

getSTATSREPORT

R Documentation

Statistics Report Template Extraction

Description

Retrieves statistics report template from .ast / .daf files.

Usage

getSTATSREPORT(fileName)

Arguments

fileName

path to file.

Details

Allowed 'statistics' names are: "Count","Mean","%Total","%Gated","%","Objects/mL","RD - Mean", "Median","CV","stddev","NaN","MAD","min","RD - Median","Variance","max","geomean","Mode".
For "%Total","%Gated","%","RD - Mean","RD - Median", 'type' has to be "ratio" and both 'population1' and 'population2' should be provided. Otherwise, 'type' is "value" and only 'population1' is mandatory.
/!\ Note that "Mode" and "Objects/mL" can't be determined and will result in NA.

Value

a 6-columns character matrix describing report instructions:
- 'name', for the desired name of exported 'statistics',
- 'type', for the type of stats to return (either "value" or "ratio"),
- 'population1', determines the population on which 'statistics' will be performed,
- 'population2', determines the reference population (when 'type' is "ratio", see Details),
- 'feature', determines the feature's name on which 'statistics' will be computed,
- 'statistics', controls the mathematical function that will be applied (see Details).