pymovements.Participants.save#

Participants.save(path: Path | str, *, metadata_path: Path | str = 'participants.json', separator: str = '\t', write_csv_kwargs: dict[str, Any] | None = None, metadata_encoding: str = 'utf-8') → None[source]#

Save participants data including metadata.

Parameters:

  • path (Path | str) – Save participants data to this path. If this is a directory, use participants.tsv as filename.

  • metadata_path (Path | str) – Save metadata json to this path. If this is a relative path it is assumed to be relative to the directory specified by path. (default: participants.json)

  • separator (str) – Separator in the tabular data file. (default: \t)

  • write_csv_kwargs (dict[str, Any] | None) – Pass these additional keyword arguments to polars.DataFrame.write_csv(). Takes precedence over the separator argument. (default: None)

  • metadata_encoding (str) – Use this encoding for loading the metadata json file. (default: utf-8)