phys2bids icon indicating copy to clipboard operation
phys2bids copied to clipboard

Update documentation

Open vinferrer opened this issue 5 years ago • 3 comments

Summary

In the last hackathon there has been many enhacements that render part of the documentation outdated.

We need to

Next Steps

  • [ ] add documentation about split multi-run physiological recordings
  • [ ] Update Bidsdify data documentation now that we have the participants.tsv, description_file.json
  • [ ] Update documentation now that most of the files go to code/coverage folder
  • [ ] Generated report documentation once #243 is finished
  • [ ] Now every multi-frequency output has a resample time channel and a resample trigger channel as soon as #288 is finished
  • [ ] Pretty sure I am missing something else

vinferrer avatar Jun 23 '20 13:06 vinferrer

Thanks for the initiative @vinferrer !

Should we add testing for multirun as well in that PR or should it be another one?

sangfrois avatar Jun 23 '20 14:06 sangfrois

Actually each of those points could be a PR. The testing is independing from all this

vinferrer avatar Jun 24 '20 10:06 vinferrer

Mention somewhere in the documentation that:

  • TRs within a scan are assumed to have even spacing.
  • All TRs are considered at the moment (none can be ignored)

RayStick avatar Jun 25 '20 19:06 RayStick