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

[ENH] Clarify the position toward non-compliant derivative datasets and files #334

Merged
merged 4 commits into from
Oct 8, 2019

Conversation

effigies
Copy link
Collaborator

This is a proposal in follow-up to #265 (comment) and the ongoing discussion. It is not intended for immediate inclusion, but as a concrete example that can be discussed and critiqued.

This is also related to #264, where discussion of non-standard files in the main specification is being updated.

@bids-standard/derivatives I would appreciate wide input on this, as it has a significant impact on the overall interpretation of the standard, with regard to tooling.

@effigies effigies changed the title [WIP] ENH: Clarify the position toward non-compliant derivative datasets and files ENH: Clarify the position toward non-compliant derivative datasets and files Sep 17, 2019
@effigies
Copy link
Collaborator Author

Given the lack of critique, I'm going to propose this to be included in common derivatives. I would appreciate reviews, @bids-standard/derivatives.

@effigies effigies added the opinions wanted Please read and offer your opinion on this matter label Sep 17, 2019
Copy link
Member

@PeerHerholz PeerHerholz left a comment

Choose a reason for hiding this comment

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

IMO, the clarification is clear and sound.

(see [Non-compliant datasets][non-compliant-datasets] for further discussion).
This specification does not prescribe anything about the contents of `sourcedata`
folders in the above example - nor does it prescribe the `sourcedata`,
`derivatives`, or `rawdata` folder names.
Copy link
Member

Choose a reason for hiding this comment

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

The last part is a bit confusing to me:

nor does it prescribe the sourcedata, derivatives, or rawdata folder names.

with that you mean that I can call my BIDS dataset root, e.g. eeg_matchingpennies ... or whatever - and it is valid BIDS? However, WITHIN eeg_matchingpennies, I am not free to give sourcedata any other name than sourcedata.

I think this could be clarified.

Copy link
Collaborator

Choose a reason for hiding this comment

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

No, I understand it as

-- whatevenyoucallthis
   |-- sourcedata_or_so
   |-- rawdata_in_bids
   `--pipeline_results_or_so
      |-- pipeline1_in_bids
      `-- pipeline2_in_bids

where the top level is up to you (e.g. it could be D:), and neither sourcedata_or_so nor pipeline_results_or_so are themselves according to BIDS. But both rawdata_in_bids and each pipelineX_in_bids directories is a BIDS dataset. So BIDS only starts playing a role further down in the directory tree, and there are three (related) BIDS datasets here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think that the example might already be more clear if it would be renamed like this

my_project/
  originaldata/
    ...
  rawdata/
    dataset_description.json
    participants.tsv
    sub-01/
    sub-02/
    ...
  my_results/
    pipeline_1/
    pipeline_2/
    ...

where only rawdata, pipeline_1 and pipeline_2 are organized according to BIDS.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, @robertoostenveld's interpretation is correct. I think part of the issue is that that context is missing from the diff.

Still, I'm happy to make any modifications (such as that suggested by Robert) which make that clearer.

@effigies effigies added this to the Common Derivatives milestone Sep 26, 2019
src/02-common-principles.md Outdated Show resolved Hide resolved
@effigies
Copy link
Collaborator Author

effigies commented Oct 8, 2019

This one has had a reasonable review period, IMO. For further concerns, please comment directly on #265.

@effigies effigies merged commit 54f6281 into bids-standard:common-derivatives Oct 8, 2019
@effigies effigies deleted the fix/relaxation branch October 8, 2019 20:44
@effigies effigies changed the title ENH: Clarify the position toward non-compliant derivative datasets and files [ENH] Clarify the position toward non-compliant derivative datasets and files Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
derivatives opinions wanted Please read and offer your opinion on this matter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants