smftools.preprocessing.load_sample_sheet

smftools.preprocessing.load_sample_sheet(adata, sample_sheet_path, mapping_key_column='obs_names', as_category=True, uns_flag='load_sample_sheet_performed', force_reload=True)

Load a sample sheet CSV and map metadata into adata.obs.

Parameters:

• adata (AnnData) -- AnnData object to append sample information to.

• sample_sheet_path (str | Path) -- Path to the CSV file.

• mapping_key_column (str (default: 'obs_names')) -- Column name to map against adata.obs_names or an obs column.

• as_category (bool (default: True)) -- Whether to cast added columns as pandas Categoricals.

• uns_flag (str (default: 'load_sample_sheet_performed')) -- Flag in adata.uns indicating prior completion.

• force_reload (bool (default: True)) -- Whether to reload even if uns_flag is set.

Returns:

Updated AnnData object.

Return type:

anndata.AnnData