omicverse.micro.Alpha.run

Contents

omicverse.micro.Alpha.run#

Alpha.run(metrics=('shannon', 'observed_otus'), write_to_obs=True, tree_key='tree')[source]#

Compute the requested alpha metrics.

Returns a DataFrame indexed by sample with one column per metric. By default the result is also merged into adata.obs with the same column names.

Parameters:
  • metrics (Union[str, Sequence[str]] (default: ('shannon', 'observed_otus')))

  • write_to_obs (bool (default: True))

  • tree_key (str (default: 'tree'))