create_from_idats

pylluminator.sample_sheet.create_from_idats(idat_folder: str | PathLike | MultiplexedPath, output_filename='samplesheet.csv') -> (<class 'pandas.core.frame.DataFrame'>, <class 'str'>)

Creates a sample sheet file from a folder containing .idat files.

Files need to follow one of the following formats :
  • [GSM_id]_[sentrix id]_[sentrix_position]_[Grn|Red].idat

  • [sentrix id]_[sentrix_position]_[Grn|Red].idat

Parameters:
  • idat_folder (str | os.PathLike | MultiplexedPath) – path to the folder containing all the .idat files

  • output_filename (str) – name of the sample sheet file that will be created. Default: ‘samplesheet.csv’

Returns:

the sample_sheet created for the .idat files as a dataframe, and the filepath of the new file

Return type:

tuple[pandas.DataFrame, str]