arviz.InferenceData.sel#

InferenceData.sel(groups=None, filter_groups=None, inplace=False, chain_prior=None, **kwargs)[source]#

Perform an xarray selection on all groups.

Loops groups to perform Dataset.sel(key=item) for every kwarg if key is a dimension of the dataset. One example could be performing a burn in cut on the InferenceData object or discarding a chain. The selection is performed on all relevant groups (like posterior, prior, sample stats) while non relevant groups like observed data are omitted. See xarray.Dataset.sel

Parameters:

groupsstr or list of str, optional: Groups where the selection is to be applied. Can either be group names or metagroup names.
filter_groups{None, “like”, “regex”}, optional, default=None: If None (default), interpret groups as the real group or metagroup names. If “like”, interpret groups as substrings of the real group or metagroup names. If “regex”, interpret groups as regular expressions on the real group or metagroup names. A la pandas.filter.
inplacebool, optional: If True, modify the InferenceData object inplace, otherwise, return the modified copy.
chain_priorbool, optional, deprecated: If False, do not select prior related groups using chain dim. Otherwise, use selection on chain if present. Default=False
kwargsdict, optional: It must be accepted by Dataset.sel().

Returns:

InferenceData: A new InferenceData object by default. When inplace==True perform selection in-place and return None