read_from_file

pylluminator.sample_sheet.read_from_file(filepath: str, delimiter: str = ',') → DataFrame | None

Read sample sheet from the provided filepath. The file must be a .csv, but you can define a custom delimiter.

Required columns in input file :

  • sample_id

Recommended :

  • sentrix_id or sentrix_barcode or sentrix_barcode_a

  • sentrix_position or sentrix_position_a

  • sample_name: For display purposes.

  • and any other metadata you’d like to use

Any other column will be left untouched in the sample sheet dataframe (with its name converted to snake case)

Parameters:

  • filepath (str) – path to the sample sheet.

  • delimiter (str) – delimiter used in the file. Default: ‘,’

Returns:

the sample sheet as a dataframe, or None if the file could not be read

Return type:

pandas.DataFrame | None