tdm.preprocess.single_cell_df.check_single_cell_df#

tdm.preprocess.single_cell_df.check_single_cell_df(single_cell_df: DataFrame, verbose: bool = True) → bool[source]#

Checks that single_cell_df is preprocessed correctly and provides hints in case it isn’t.

Note

The single_cell_df must have:

x (float) and y (float) columns with spatial coordinates in standard units (e.g 1 micron = 1e-6)
a cell_type (str) column.
a division (bool) column.
an img_id (int) column with an identifier of the tissue section
a subject_id (int | str) column with an identifier of the patient (or mouse etc.)