bids.variables.BIDSVariableCollection

class BIDSVariableCollection(variables, name=None)

A container for one or more variables extracted from variable files at a single level of analysis.

Parameters:

• variables (list) – A list of BIDSVariables or SimpleVariables.

• name (str) – Optional name to assign to the collection.

Notes

Variables in the list must all share the same analysis level, which must be one of ‘session’, ‘subject’, or ‘dataset’ level. For run-level Variables, use the BIDSRunVariableCollection.

Methods

clone()	Returns a copy of the current instance.
from_df(data[, entities, source])	Create a Collection from a pandas DataFrame.
match_variables(pattern[, return_type, ...])	Return columns whose names match the provided pattern.
merge_variables(variables, **kwargs)	Concatenates Variables along row axis.
to_df([variables, format, fillna, entities, ...])	Merge BIDVariables in the collection into a single pandas DataFrame.

__init__(variables, name=None)

Methods

__init__(variables[, name])
clone()	Returns a copy of the current instance.
from_df(data[, entities, source])	Create a Collection from a pandas DataFrame.
match_variables(pattern[, return_type, ...])	Return columns whose names match the provided pattern.
merge_variables(variables, **kwargs)	Concatenates Variables along row axis.
to_df([variables, format, fillna, entities, ...])	Merge BIDVariables in the collection into a single pandas DataFrame.