nipoppy.tabular.manifest

Class for the dataset manifest.

Module Contents

class nipoppy.tabular.manifest.Manifest(*args, session_ids=None, visit_ids=None, **kwargs)

Bases: nipoppy.tabular.base.BaseTabular

A dataset’s manifest.

col_datatype = 'datatype'

col_participant_id = 'participant_id'

col_session_id = 'session_id'

col_visit_id = 'visit_id'

index_cols

model

get_imaging_subset(session_id=None)

Get records with imaging data.

Parameters:

session_id (Optional[str])

get_participants_sessions(participant_id=None, session_id=None)

Get participant IDs and session IDs.

Parameters:

• participant_id (Optional[str])

• session_id (Optional[str])

classmethod load(*args, session_ids=None, visit_ids=None, validate=True, **kwargs)

Load the manifest.

Return type:

typing_extensions.Self

validate(*args, **kwargs)

Validate the manifest.

Return type:

typing_extensions.Self

class nipoppy.tabular.manifest.ManifestModel(/, **data)

Bases: nipoppy.tabular.base.BaseTabularModel

A user-provided listing of participant and visits available in the dataset.

Note: This class is called “model” to be consistent with Pydantic nomenclature, but it can be thought of as a schema for each row in the manifest file.

Parameters:

data (Any)

datatype: list[str] | None

model_config

participant_id: str

session_id: str | None

visit_id: str

validate_after()

Validate fields after instance creation.

Return type:

typing_extensions.Self