nipoppy status

Note

This command calls the nipoppy.workflows.dataset_status.StatusWorkflow class from the Python API internally.

nipoppy status

Print a summary of the dataset.

Usage

nipoppy status [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.

--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