readFCSheader: FCS Header Parser

View source: R/fcs.R

readFCSheaderR Documentation

FCS Header Parser

Description

Helper to parse header segment from Flow Cytometry Standard (FCS) compliant files.

Usage

readFCSheader(fileName, header, encoding = "UTF-8", ...)

Arguments

fileName

path to file.

header,

a list whose members define the "at" offset from header$start$at and the "n" number of bytes to extract:
- start: where to start reading current FCS dataset. Default is list(at = 0, n = 6),
- space: where to retrieve space. Default is list(at = 6, n = 4),
- text_beg: where to retrieve file text segment beginning. Default is list(at = 10, n = 8),
- text_end: where to retrieve file text segment end. Default is list(at = 18, n = 8),
- data_beg: where to retrieve file data segment beginning. Default is list(at = 26, n = 8),
- data_end: where to retrieve file data segment end. Default is list(at = 34, n = 8).

encoding

name of the encoding for raw to character conversion. Default is "UTF-8".

...

other arguments to be passed.


IFC documentation built on Sept. 14, 2023, 1:08 a.m.