pymovements.Dataset.scan#

Dataset.scan(*, participant_key: str = 'participant_id') → Dataset[source]#

Infer information from filepaths and filenames.

Sets fileinfo and participants.

Parameters:

participant_key (str) – The participant key used for identifying a participant. See scan_participants() for more details. (default: ‘participant_id’)

Returns:

Returns self, useful for method cascading.

Return type:

Dataset

Raises:

  • AttributeError – If no regular expression for parsing filenames is defined.

  • RuntimeError – If an error occurred during matching filenames or no files have been found.