nipoppy.tabular.processing_status.ProcessingStatusTable

class nipoppy.tabular.processing_status.ProcessingStatusTable(*args, **kwargs)

A file to track data availability/processing status.

get_completed_participants_sessions(pipeline_name, pipeline_version, pipeline_step, participant_id=None, session_id=None)

Get participant-session pairs that have successfully completed a pipeline run.

Can optionally filter within a specific participant and/or session.

Parameters:
  • pipeline_name (str)

  • pipeline_version (str)

  • pipeline_step (str)

  • participant_id (Optional[str])

  • session_id (Optional[str])

col_bids_participant_id = 'bids_participant_id'
col_bids_session_id = 'bids_session_id'
col_participant_id = 'participant_id'
col_pipeline_name = 'pipeline_name'
col_pipeline_step = 'pipeline_step'
col_pipeline_version = 'pipeline_version'
col_session_id = 'session_id'
col_status = 'status'
index_cols
model

Model class associated with the tabular data.

status_fail = 'FAIL'
status_incomplete = 'INCOMPLETE'
status_success = 'SUCCESS'
status_unavailable = 'UNAVAILABLE'