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

Update documentation #264

Open
6 tasks
vinferrer opened this issue Jun 23, 2020 · 3 comments
Open
6 tasks

Update documentation #264

vinferrer opened this issue Jun 23, 2020 · 3 comments
Assignees
Labels
Documentation This issue or PR is about the documentation Urgent If you don't know where to start, start here!

Comments

@vinferrer
Copy link
Collaborator

vinferrer commented Jun 23, 2020

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 Generate report with phys2bids outputs #243 is finished
  • Now every multi-frequency output has a resample time channel and a resample trigger channel as soon as Add (resampled) trigger to all output files  #288 is finished
  • Pretty sure I am missing something else
@vinferrer vinferrer added the Documentation This issue or PR is about the documentation label Jun 23, 2020
@sangfrois
Copy link
Member

Thanks for the initiative @vinferrer !

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

@vinferrer
Copy link
Collaborator Author

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

@RayStick
Copy link
Member

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation This issue or PR is about the documentation Urgent If you don't know where to start, start here!
Projects
None yet
Development

No branches or pull requests

6 participants