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

For BIDS subjects with only one session (and therefore no ses subdirectory), create a new session object with label 01 #82

Closed
2 tasks done
Tracked by #27
alyssadai opened this issue Feb 22, 2023 · 3 comments · Fixed by #88
Closed
2 tasks done
Tracked by #27
Assignees

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Feb 22, 2023

  • Newly created session should have an obvious name that distinguishes it from BIDS-created sessions -ses-nb01
  • Add a comment in the portion of the code that will handle this edge case (and probably also in the test that is assuring it works) as to why we have decided to do this, and maybe also a TODO note to come back and revisit this
@alyssadai
Copy link
Contributor Author

@surchs just confirming that we still want to do this to be in line with what we decided for the api, neurobagel/api#81 (comment)?

@alyssadai alyssadai moved this from Inbox to Next in Neurobagel Feb 22, 2023
@surchs
Copy link
Contributor

surchs commented Feb 23, 2023

I think yes @alyssadai, but it's a bit tricky. Because if we do this without also changing the underlying BIDS data by adding a ses-01 directory, then we are breaking our existing promise of "all information in the graph is just a representation of what's on disk". On the other hand, if we do decide to change the BIDS dataset (or in the future expect that others do so before using our tools), then we break a different existing promise of "we don't change your existing data, keep doing what you're doing".

I see the reason for being consistent in our modeling and creating a session if none exists. Maybe for now we can add some clarity to what we're doing by:

  • documenting this behaviour of adding a session in the graph even if none exists in the file system prominently in the user facing docs
  • calling the newly created session something obvious like ses-neurobagelcreated
  • leaving a comment in the portion of the code that will handle this edge case (and probably also in the test that is assuring it works) as to why we have decided to do this, and maybe also a TODO note to come back and revisit this

What do you think?

@alyssadai alyssadai moved this from Next to Doing in Neurobagel Feb 23, 2023
@alyssadai
Copy link
Contributor Author

alyssadai commented Feb 23, 2023

Good points about changing the data on disk. The implementation I'm currently working on indeed creates a new session in the BIDS dataset representation without changing anything in the filesystem.

Will follow your suggestions for keeping the behaviour clear in the code 🙂
edit: have updated the issue description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants