We expect a custom_selections
HDF5 group at the root of the file, containing information about the custom selections.
The group itself contains the parameters
and results
subgroups.
Definitions:
modalities
: an array of names of modalities with available embeddings. This is based on the availability of embeddings in thepca
andadt_pca
stepsnum_cells
: number of cells remaining after QC filtering. This is typically determined from thecell_filtering
step.num_features
: an array of length equal tomodalities
, containing the number of features present in each modality. This is typically determined from theinputs
step.
parameters
should contain:
selections
: a group defining the custom selections. Each child is named after a user-created selection. Each child is an integer dataset of arbitrary length containing the indices of the selected cells. Note that indices refer to the dataset after QC filtering and should be less thannum_cells
.
results
should contain per_selection
, a group containing the marker results for each selection after a comparison to a group containing all other cells.
Each child of per_selection
is named after its selection and is itself a group containing children named after modalities
.
Each modality-specific child is yet another group containing the statistics for that modality:
means
: a float dataset of length equal to the number of features in that modality (as determined fromnum_features
), containing the mean expression of each gene in the selection.detected
: a float dataset of length equal to the number of features in that modality, containing the proportion of cells with detected expression of each gene in the selection.lfc
: a float dataset of length equal to the number of features in that modality, containing the log-fold change in the selection compared to all other cells.delta_detected
: same aslfc
, but for the delta-detected (i.e., difference in the percentage of detected expression).cohen
: same aslfc
, but for Cohen's d.auc
: same aslfc
, but for the AUCs.
Updated in version 2.0, with the following changes from the previous version:
- Support multiple modalities in the results.