Physiopy-documentation
Title
Physiopy-documentation: Writing and organising documentation for physiological data handling
Leaders
Sarah Goodale (@s_goodale23) Inês Esteves (@isesteves)
Collaborators
No response
Brainhack Global 2022 Event
Brainhack Physiopy
Project Description
Physiopy is a community formed around developing tools to operate physiological files in neuroimaging setups. This project specifically will expand our package documentation containing tips and strategies on how to collect and analyze various forms of physiological data and the use of our packages. Contributors may get started from any skill set and level, as this project will predominantly be focused on documentation contributions. Most of all, we are looking for people excited to learn (and contribute to) the best practices in physiological signal acquisition.
Link to project repository/sources
https://github.com/physiopy/physiopy.github.io
Goals for Brainhack Global
We aim to provide a succinct overview of what physiological data are typically recorded during an fMRI experiment, how these signals are recorded, and how these signals can improve our modeling of fMRI time series data. This is an active field of research, and we hope to encourage all users to get the latest recommendations prior to initiating a new study.
Good first issues
- Improve the documentation for Physiopy’s packages
- Build best practices libraries and summaries for various physiological signals (e.g., respiratory, cardiac, skin conductance, etc.)
- Search for additional open source libraries and software similar to what we do
- Find links to educational courses of interest
- Enlarge our list of open source datasets with physiological signals
- Improve the website’s interface
Communication channels
https://physiopy.slack.com/archives/C042U2KLF36
Skills
GitHub: basic Markdown: basic to advanced Physiological data acquisition/analysis: basic to advanced
Onboarding documentation
https://docs.github.com/en/get-started https://www.markdownguide.org/
What will participants learn?
Participants will learn (at least) the basics about different types of physiological data acquired in neuroimaging setups and how they can be used. In addition, they will get acquainted with Github and Markdown, which may be helpful in other contexts.
Data to use
No response
Number of collaborators
more
Credit to collaborators
Project contributors are listed on our Team page.
Image
Type
documentation
Development status
1_basic structure
Topic
MR_methodologies, physiology
Tools
other
Programming language
documentation
Modalities
fMRI, MRI
Git skills
0_no_git_skills, 1_commit_push, 2_branches_PRs
Anything else?
No response
Things to do after the project is submitted and ready to review.
- Add a comment below the main post of your issue saying:
Hi @brainhackorg/project-monitors my project is ready! - Twitter-sized summary of your project pitch.