lsdb.nested.utils.utils

lsdb.nested.utils.utils#

Functions#

count_nested(→ lsdb.nested.core.NestedFrame)

Counts the number of rows of a nested dataframe.

Module Contents#

count_nested(df, nested, by=None, join=True) → lsdb.nested.core.NestedFrame[source]#

Counts the number of rows of a nested dataframe.

Wraps Nested-Pandas count_nested.

Parameters:

  • df (NestedFrame) – A NestedFrame that contains the desired nested series to count.

  • nested ('str') – The label of the nested series to count.

  • by ('str', optional) – Specifies a column within nested to count by, returning a count for each unique value in by.

  • join (bool, optional) – Join the output count columns to df and return df, otherwise just return a NestedFrame containing only the count columns.

Return type:

NestedFrame

Contents