nipoppy doughnut¶
Note
This command calls the nipoppy.workflows.doughnut.DoughnutWorkflow class from the Python API internally.
Logfiles for this command can be found in {{dpath_logs}}/doughnut.
nipoppy doughnut¶
Create or update a dataset’s doughnut file.
nipoppy doughnut [OPTIONS] [DATASET_ARGUMENT]
Options
- --dataset <dpath_root>¶
Path to the root of the dataset (default is current working directory).
- Default:
PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/nipoppy/checkouts/0.3.4/docs/source')
- --empty¶
Set all statuses to False in newly added records (regardless of what is on disk). May be useful to reduce runtime.
- -f, --regenerate, --force¶
Regenerate the doughnut file even if it already exists (default: only append rows for new records)
- --layout <fpath_layout>¶
Path to a custom layout specification file, to be used instead of the default layout.
- -n, --dry-run¶
Print commands but do not execute them.
- -v, --verbose¶
Verbose mode (Show DEBUG messages).
Arguments
- DATASET_ARGUMENT¶
Optional argument