nbnode.utils package¶

Submodules¶

nbnode.utils.merge_leaf_nodes.merge_leaf_nodes(leaf_nodes_df: DataFrame, intermediate_node: str) → float[source]¶

Merge leaf node dataframe into intermediate node.

Parameters:

intermediate_node (str) – The (full) name of the intermediate node to merge leaf nodes into.
leaf_nodes_df (pd.DataFrame) –
The dataframe of leaf nodes to merge into the intermediate node. Its index are the full names of the leaf nodes. The names are organized in a hierarchy, separated by “/”. Therefore, any intermediate node is a prefix of any of its leaf nodes.

For some values it is useful to have the sum of all leaf nodes, especially for:
- Dirichlet concentration parameters
- Means of cell proportions
- Numbers of cells

Returns:

Sum of all leaf nodes whose names start with the intermediate node name

Return type:

float