nipoppy.tabular¶

Classes for tabular data representation/manipulation.

Submodules¶

Classes¶

`Bagel`	A file to track data availability/processing status.
`Doughnut`	A dataset's doughnut, for tracking DICOM-to-BIDS conversion status.
`Manifest`	A dataset's manifest.

Package Contents¶

nipoppy.tabular.generate_doughnut(manifest, dicom_dir_map, dpath_downloaded=None, dpath_organized=None, dpath_bidsified=None, empty=False, logger=None)¶

Generate a doughnut object.

Parameters:

manifest (nipoppy.tabular.manifest.Manifest)
dicom_dir_map (nipoppy.tabular.dicom_dir_map.DicomDirMap)
dpath_downloaded (Optional[nipoppy.env.StrOrPathLike])
dpath_organized (Optional[nipoppy.env.StrOrPathLike])
dpath_bidsified (Optional[nipoppy.env.StrOrPathLike])
logger (Optional[logging.Logger])

Return type:

Doughnut

nipoppy.tabular.update_doughnut(doughnut, manifest, dicom_dir_map, dpath_downloaded=None, dpath_organized=None, dpath_bidsified=None, empty=False, logger=None)¶

Update an existing doughnut file.

Parameters:

doughnut (Doughnut)
manifest (nipoppy.tabular.manifest.Manifest)
dicom_dir_map (nipoppy.tabular.dicom_dir_map.DicomDirMap)
dpath_downloaded (Optional[nipoppy.env.StrOrPathLike])
dpath_organized (Optional[nipoppy.env.StrOrPathLike])
dpath_bidsified (Optional[nipoppy.env.StrOrPathLike])
logger (Optional[logging.Logger])

Return type:

Doughnut