get_or_download_annotation_data

pylluminator.annotations.get_or_download_annotation_data(annotation_name: str, data_type: str, output_folder: str | MultiplexedPath | PathLike, dl_link: str) → DataFrame | None

Check if the csv file exists, and if not download it from the given link and save it in the output folder under the same name.

Read the file as a pandas dataframe, with the first column being the index, and return it. Return None if no file was found

Parameters:

• annotation_name (str) – custom annotation name, ‘illumina’ for pylluminator-data annotations, or ‘updated’ for the updated annotations (EPICv2 only)

• data_type (str) – data to download (probe_infos, seq_length…). Must match the file name

• output_folder (str | MultiplexedPath | os.PathLike) – where to locally save the file

• dl_link (str) – link to download the file from

Returns:

a dataframe or None if no file was downloaded

Return type:

pandas.DataFrame | None