get_subcolumns

NestedFrame.get_subcolumns(nested_columns='all') → list[str]

Returns a set of all subcolumn names from a set of nested columns, including dot notation

Parameters:

nested_columns ('all' or str or list of str, optional) – The nested columns to get subcolumns from. Default is ‘all’, which means all nested columns.

Returns:

A list of subcolumn names in dot notation, e.g. ‘nested.a’

Return type:

list of str

Examples

>>> from nested_pandas.datasets import generate_data

>>> nf = generate_data(5,10, seed=1)
>>> nf["nested2"] = nf["nested"]  # create a second nested column for demonstration
>>> nf.get_subcolumns()
['nested.t', 'nested.flux', 'nested.flux_error', 'nested.band',
'nested2.t', 'nested2.flux', 'nested2.flux_error', 'nested2.band']

>>> nf.get_subcolumns("nested")
['nested.t', 'nested.flux', 'nested.flux_error', 'nested.band']