FlowCytometryTools.FCPlate.from_files

classmethod FCPlate.from_files(ID, datafiles, parser='name', position_mapper=None, ID_kwargs={}, **kwargs)

Create an OrderedCollection of measurements from a set of data files.

Parameters:

ID : hashable

Collection ID

datafiles : str | iterable

A set of data files containing the measurements.

parser : [‘name’ | ‘number’ | ‘read’ | mapping | callable]

Given a filename corresponding to a measurement, the parser extracts a key from the filenmae.

Later, this key is used by the position mapper to determine the location of the measurement in the measurement collection.

  • ‘name’ : Use the measurement name given in the file name.

    For example, ‘[whatever]_Well_C9_[blah].fcs’ will get key ‘C9’. The filename must look exactly like the template above.

  • ‘number’ : Use the number given in the file name.

    For example, ‘[some name].001.fcs’ will get key 001. The filename must look exactly like the template above.

  • ‘read’ : Use the measurement ID specified in the metadata.

  • mapping : mapping (dict-like) from datafiles to keys.

  • callable : takes datafile name and returns key.

position_mapper : [None, callable, mapping, ‘name’, ‘number’]

Accepts a key (which is extracted by the parser), and returns the coordinates in a matrix (measurement collection) that correspond to the key.

For example, the key ‘A1’ corresponds to the matrix coordinate (0, 0).

  • None : use the parser value, if it is a string.
  • callable : gets key and returns position
  • mapping : key:pos
  • ‘name’ : parses things like ‘A1’, ‘G12’
  • ‘number’ : converts number to positions, going over rows first.

ID_kwargs: dict :

Additional parameters to be used when assigning IDs. Passed to ‘_assign_IDS_to_datafiles’ method.

kwargs : dict

Additional key word arguments to be passed to constructor.