nipoppy.workflows.dataset_init.InitWorkflow

class nipoppy.workflows.dataset_init.InitWorkflow(dpath_root, bids_source=None, mode='symlink', force=False, fpath_layout=None, verbose=False, dry_run=False)

Workflow for init command.

Parameters:
  • dpath_root (pathlib.Path)

  • fpath_layout (Optional[nipoppy.env.StrOrPathLike])

  • verbose (bool)

  • dry_run (bool)

handle_bids_source()

Create bids source directory.

Handles copy/move/symlink modes. If –force, attempt to remove the pre-existing conflicting bids source.

Return type:

None

run_cleanup()

Log a success message.

run_main()

Create dataset directory structure.

Create directories and add a readme in each. Copy boutiques descriptors and invocations. Copy default config files. Copy HPC config files.

bids_source = None
fname_readme = 'README.md'
force = False
mode = 'symlink'