nipoppy track-processing

Note

This command calls the nipoppy.workflows.tracker.PipelineTracker class from the Python API internally.

nipoppy track-processing

Track the processing status of a pipeline.

Usage

nipoppy track-processing [OPTIONS]

Options

--dataset <dpath_root>

Path to the root of the dataset. Default: current working directory or the closest parent directory that contains a .nipoppy directory.

--pipeline <pipeline_name>

Required Pipeline name, as specified in the config file.

--pipeline-version <pipeline_version>

Pipeline version, as specified in the pipeline config file (default: latest out of the installed versions).

--pipeline-step <pipeline_step>

Pipeline step, as specified in the pipeline config file (default: first step).

--participant-id <participant_id>

Participant ID (with or without the sub- prefix).

--session-id <session_id>

Session ID (with or without the ses- prefix).

--n-jobs <n_jobs>

Number of parallel workers to use.

--dry-run

Print commands but do not execute them.

-v, --verbose

Verbose mode (Show DEBUG messages).

--layout <fpath_layout>

Path to a custom layout specification file, to be used instead of the default layout.

Environment variables

NIPOPPY_LAYOUT

Provide a default for --layout