[ENH] BEP022 - Magnetic Resonance Spectroscopy

[markmikkelsen]

This pull request adds MRS BIDS-compliant datasets to the bids-examples repository. It includes three datasets: mrs_2dmrsi/, mrs_biggaba/, and mrs_fmrs/.

[Remi-Gau]

@markmikkelsen do you think you could add a README.md to each dataset?

one of them has an excellent README but the 2 others have none

There is a README template in the bids starter kit if that can help: https://github.com/bids-standard/bids-starter-kit/blob/main/templates/README.MD?plain=1

[Remi-Gau]

@effigies do you think we should / could use this PR to use citation.cff files?

I think we do not have any example that make use of them.

[effigies]

Not unless Mark already has CITATION.cff files he wants to include. We don't need to pile on tasks to this BEP. Let's make a separate PR that adds a citation file to an existing example.

[Remi-Gau]

oh yeah of course!! that's fair!

will open an issue to see if we can actually do it in another dataset that already exist.

[Remi-Gau]

• you know you are getting old when you don't remember the issues you have opened yourself https://github.com/bids-standard/bids-examples/issues/422

🤦🏾 👴🏾

[markmikkelsen]

@markmikkelsen do you think you could add a README.md to each dataset?

one of them has an excellent README but the 2 others have none

There is a README template in the bids starter kit if that can help: https://github.com/bids-standard/bids-starter-kit/blob/main/templates/README.MD?plain=1

Yep! I've just added these files.

[markmikkelsen]

This pull request is nearly ready for merging. The check failures relate to the MRS filename suffices not being included in the bids-validator.

[effigies]

There are no examples of nuc- or voi- entities. These would be helpful for validating entity ordering.

[markmikkelsen]

There are no examples of nuc- or voi- entities. These would be helpful for validating entity ordering.

I'm ignorant of how the validator works, but does it rely on examples? My impression was that it was contingent on the current stable specification. So, how do example datasets factor into validation?

[Remi-Gau]

There are no examples of nuc- or voi- entities. These would be helpful for validating entity ordering.

I'm ignorant of how the validator works, but does it rely on examples? My impression was that it was contingent on the current stable specification. So, how do example datasets factor into validation?

in short and in a very hand wavy way:

the validator tries to implement the specification so we need examples to ensure that the validator work as expected (they act as some sort of ground truth)

so the richer the examples, the more we can be sure that the validator has fewer blind spots

[markmikkelsen]

Gotcha. Since the datasets are not real. I can just create a bunch of example of fake datasets to satisfy this.

[effigies]

@markmikkelsen @wtclarke Note that BIDS doesn't permit null values, but instead leaves fields blank. Fixed in bc92a4d. Not sure if you need to update converters.