Groups#

A group is a set of related series (e.g. the scenarios of a same signal) manipulated as a single object. Most operations available on individual series have a group counterpart, prefixed with group_.

group_exists

Checks the existence of a group with a given name.

group_get

Get a group by name.

group_update

Update a group named by <name> with the input dataframe.

group_replace

Replace a group named by <name> with the input dataframe.

group_delete

Override to add dependency checking.

group_rename

Rename a group.

group_type

Return the type of a group, for instance 'primary', 'formula' or 'bound'

group_source

Provide the source name of a group.

group_interval

Return the value date range of a group.

group_inferred_freq

Return the inferred frequency of a group.

group_insertion_dates

Get the list of all insertion dates for any given group

group_history

Get all versions of a group in the form of a dict from insertion dates to dataframe.

group_log

group_metadata

Return a group metadata dictionary.

group_internal_metadata

Return a group internal metadata dictionary.

group_old_metadata

Get a list of the the older versions of the metadata.

update_group_metadata

Update a group metadata with a dictionary from strings to anything json-serializable.

replace_group_metadata

Replace a group metadata with a dictionary from strings to anything json-serializable.

group_find

Return a list of group descriptors matching the query.

group_catalog

Produces a catalog of all groups in the form of a mapping from source to a list of (name, kind) pair.