pycea.pp.add_depth

Contents

pycea.pp.add_depth#

pycea.pp.add_depth(tdata, key_added='depth', tree=None, copy=False)#
Overloads:

  • tdata (td.TreeData), key_added (str), tree (str | Sequence[str] | None), copy (Literal[True, False]) → None

  • tdata (td.TreeData), key_added (str), tree (str | Sequence[str] | None), copy (Literal[True, False]) → pd.DataFrame

Adds a depth attribute to the tree.

Parameters:

  • tdata (TreeData) – TreeData object.

  • key_added (str (default: 'depth')) – Key to store node depths.

  • tree (str | Sequence[str] | None (default: None)) – The obst key or keys of the trees to use. If None, all trees are used.

  • copy (Literal[True, False] (default: False)) – If True, returns a DataFrame with node depths.

Returns:

Returns None if copy=False, else returns node depths.

Sets the following fields:

  • tdata.obs[key_added]Series (dtype float)

    • Distance from the root node.

  • tdata.obst[tree].nodes[key_added]float

    • Distance from the root node.

Contents