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

[FIX] fix inconsistencies for task label between sections #446

Merged
merged 6 commits into from
Apr 17, 2020

Conversation

Remi-Gau
Copy link
Collaborator

Related to issue #445

  • uniformize task-<label> in the filename template across sections
  • make the TaskName description for the JSON sidecar exactly match that of fMRI
  • fix some typos

@sappelhoff
Copy link
Member

Thanks for the fixes @Remi-Gau! :-)

Unfortunately the edits have misaligned a few table fences, Can you fix the linter, please?

Also I find this new phrasing a bit hard to understand. What was your intention with this change?

-The Task label is derived from this field ...
+Task label (`task-`) included in the file name is derived from this field ...
(`task-`) 

is not the task label, but rather the key of the "task key-value pair", with the label being the value. So that's why I am a bit confused.

@Remi-Gau
Copy link
Collaborator Author

Also I find this new phrasing a bit hard to understand. What was your intention with this change?

-The Task label is derived from this field ...
+Task label (`task-`) included in the file name is derived from this field ...
(`task-`) 

is not the task label, but rather the key of the "task key-value pair", with the label being the value. So that's why I am a bit confused.

For this, I literally reused the wording from the fMRI section. So I suspect we might want to clarify this one to have all sections consistent. :-)

How about this?

The task label included in the file name is derived from this TaskName field by removing all non alphanumeric (`[a-zA-Z0-9]`) characters. For example TaskName `faces n-back` will correspond to task label `facesnback`.

FYI the behavioral section has no corresponding description for the task label but the explaining text says to refer to the other sections, so it should be enough IMHO.

@sappelhoff
Copy link
Member

For this, I literally reused the wording from the fMRI section.

I see 🤔

I like your new suggestion from #446 (comment) and agree that having this consistent across the spec is good to have 👍

sappelhoff
sappelhoff previously approved these changes Apr 15, 2020
@effigies
Copy link
Collaborator

Sorry, one annoying suggestion: "non alphanumeric" should be "non-alphanumeric".

And let's update the entry in MRI, to be consistent:

| TaskName | REQUIRED. Name of the task. No two tasks should have the same name. Task label (`task-`) included in the file name is derived from this field by removing all non alphanumeric (`[a-zA-Z0-9]`) characters. For example task name `faces n-back` will corresponds to task label `facesnback`. A RECOMMENDED convention is to name resting state task using labels beginning with `rest`. |

@Remi-Gau
Copy link
Collaborator Author

And let's update the entry in MRI, to be consistent:

Can't believe I did not update the MRI section. Silly me.

@sappelhoff sappelhoff merged commit fba9a38 into bids-standard:master Apr 17, 2020
@sappelhoff
Copy link
Member

Thanks @Remi-Gau!

@Remi-Gau Remi-Gau deleted the remi-fixe_task_label branch October 2, 2020 05:39
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.

3 participants