ENH: add HeudiconvVersion to sidecar .json files #529
Merged
+30
−10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Unfortunately there is no convention yet in BIDS on storing such information in a standardized way. bids-standard/bids-specification#440 proposes to add GeneratedBy (within dataset_description.json) which could provide detailed high level information which should then be consistent through out dataset (so we would need to add safeguards) bids-standard/bids-specification#487 is WiP to introduce PROV into BIDS standard, which would allow to establish _prov.json with all needed gory details. For now, since fields in side car .json files are not strictly regulated, I think it would be benefitial to user to have heudiconv version stored there along with other "Version" fields, such as $> grep -e Version -e dcm2ni fmap/sub-phantom1sid1_ses-localizer_acq-3mm_phasediff.json "ConversionSoftware": "dcm2niix", "ConversionSoftwareVersion": "v1.0.20211006", "SoftwareVersions": "syngo MR E11", and although strictly speaking Heudiconv is a "conversion software", since dcm2niix decided to use that pair, I have decided to leave it alone and just come up with yet another descriptive key "HeudiconvVersion": "0.10.0",
Codecov Report
@@ Coverage Diff @@
## master #529 +/- ##
==========================================
+ Coverage 77.48% 77.56% +0.08%
==========================================
Files 41 41
Lines 3135 3147 +12
==========================================
+ Hits 2429 2441 +12
Misses 706 706
Continue to review full report at Codecov.
|
|
if no comments/objections are voiced, I will merge in 2 days. |
|
🚀 PR was released in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Unfortunately there is no convention yet in BIDS on storing such information in
a standardized way.
bids-standard/bids-specification#440
proposes to add GeneratedBy (within dataset_description.json)
which could provide detailed high level information which should then be
consistent through out dataset (so we would need to add safeguards)
bids-standard/bids-specification#487
is WiP to introduce PROV into BIDS standard, which would allow to establish
_prov.json with all needed gory details.
For now, since fields in side car .json files are not strictly regulated,
I think it would be benefitial to user to have heudiconv version stored there
along with other "Version" fields, such as
and although strictly speaking Heudiconv is a "conversion software", since
dcm2niix decided to use that pair, I have decided to leave it alone and just
come up with yet another descriptive key
"HeudiconvVersion": "0.10.0",