readfcs.view¶
- readfcs.view(filepath, data_set=0, ignore_offset_error=False, ignore_offset_discrepancy=False, use_header_offsets=False, only_text=False)¶
Read in file content without preprocessing for debugging.
- Parameters:
filepath (
str|Path) – Location of fcs file to parsedata_set (
int, default:0) – Index of retrieved data set in the fcs file.ignore_offset_error (
bool, default:False) – Ignore data offset error.ignore_offset_discrepancy (
bool, default:False) – Ignore discrepancy between the HEADER and TEXT values for the DATA byte offset location.use_header_offsets (
bool, default:False) – Use the HEADER section for the data offset locations. Setting this option to True also suppresses an error in cases of an offset discrepancy.only_text (
bool, default:False) – Only read the “text” segment of the FCS file without loading event data.
- Return type:
tuple- Returns:
a tuple of (data, metadata) - data is a DataFrame - metadata is a dictionary
- See
flowio.FlowData: https://flowio.readthedocs.io/en/latest/api.html#flowio.FlowData