smftools.preprocessing.calculate_consensus

Functions

calculate_consensus(adata, reference[, ...])

Calculate a consensus sequence for a reference (and optional sample).

smftools.preprocessing.calculate_consensus.calculate_consensus(adata, reference, sample=False, reference_column='Reference', sample_column='Sample')

Calculate a consensus sequence for a reference (and optional sample).

Parameters:

• adata (AnnData) -- AnnData object to append consensus metadata to.

• reference (str) -- Reference name to subset on.

• sample (str | bool (default: False)) -- If False, uses all samples. If a string is passed, subsets to that sample.

• reference_column (str (default: 'Reference')) -- Obs column with reference names.

• sample_column (str (default: 'Sample')) -- Obs column with sample names.

Return type:

None