Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add "GeneratedBy"s in dataset_description.json for BIDS 1.4+ compliance #1019

Merged
merged 1 commit into from
Sep 13, 2023

Conversation

pierre-nedelec
Copy link
Collaborator

Fixes #1018

Copy link
Collaborator

@arokem arokem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had this in a previous PR, that was eventually closed: #870. I think that we were waiting for bids-standard/pybids#864 to get merged in pybids first, but if this now works without that, I would be OK making this change now.

"Version": pyafq_version}}
"Version": pyafq_version},
"GeneratedBy": [{"Name": op.basename(self.afq_path),
"Version": pyafq_version}]}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you really have both of these side-by-side?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left the PipelineDescription for compatibility. I think it's just going to be extra and should be deleted in the near future.

Comment on lines +190 to +192
"Version": pyafq_version},
"GeneratedBy": [{"Name": op.basename(self.afq_path),
"Version": pyafq_version}]}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, while we're here, could we add something like:

Suggested change
"Version": pyafq_version},
"GeneratedBy": [{"Name": op.basename(self.afq_path),
"Version": pyafq_version}]}
"Version": pyafq_version},
"GeneratedBy": [{"Name": op.basename(self.afq_path),
"Version": pyafq_version}],
"HowToAcknowledge": "Please cite this paper: https://apertureneuro.org/article/77465-evaluating-the-reliability-of-human-brain-white-matter-tractometry"}

Copy link
Collaborator

@arokem arokem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this is passing the CI tests, so I will go ahead and merge it.

@arokem arokem merged commit 75d360f into master Sep 13, 2023
17 checks passed
@pierre-nedelec pierre-nedelec deleted the pierre-nedelec/issue1018 branch September 14, 2023 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BIDS v1.4+ requires "GeneratedBy" instead of "PipelineDescription" in dataset_description.json
2 participants