scirpy.tl.spectratype
- scirpy.tl.spectratype(adata, groupby='IR_VJ_1_junction_aa', *, target_col, combine_fun=<function sum>, fraction=None)
Summarizes the distribution of CDR3 region lengths.
Ignores NaN values.
- Parameters
- adata :
AnnData AnnData object to work on.
- groupby :
str|Collection[str]Union[str,Collection[str]] (default:'IR_VJ_1_junction_aa') Column(s) containing CDR3 sequences.
- target_col :
str Color by this column from
obs. E.g. sample or diagnosis- combine_fun :
Callable(default:<function sum at 0x00000277B4191670>) A function definining how the groupby columns should be merged (e.g. sum, mean, median, etc).
- fraction :
None|str|boolUnion[None,str,bool] (default:None) If True, compute fractions of abundances relative to the
groupbycolumn rather than reporting abosolute numbers. Alternatively, a column name can be provided according to that the values will be normalized.
- adata :
- Return type
- Returns
A DataFrame with spectratype information.