Participants#

class pymovements.Participants(data: DataFrame | None = None, metadata: dict[str, Any] | None = None, *, infer_metadata: bool = True)[source]#

Participant table with additional metadadata.

data#

The participant data conforming to BIDS (i.e., first column must be named participant_id).

Type:

polars.DataFrame

metadata#

Additional metadata on participant data conforming to BIDS side car json files.

Type:

dict[str, Any]

Parameters:

  • data (polars.DataFrame | None) – The participant data conforming to BIDS (i.e., first column must be named participant_id). If None, initialize an empty dataframe with a participant_id string column.

  • metadata (dict[str, Any] | None) – Additional metadata on participant data conforming to BIDS side car json files. If None, initialize an empty dictionary. (default: None)

  • infer_metadata (bool) – Infer metadata column format descriptors from data. (default: True)

Methods

__init__([data, metadata, infer_metadata])

load(path[, metadata, separator, rename, ...])

Load participant data from participant files.

save(path, *[, metadata_path, separator, ...])

Save participants data including metadata.

update(data[, metadata])

Update participants data.

Attributes

data

metadata