Home - ComputationalPsychiatry/PhysIO GitHub Wiki
This Wiki contains the most up-to date User Guide to the PhysIO Toolbox. It is most conveniently viewed online with gitlab-formatting. Its content can also be retrieved offline after downloading the toolbox, in folder physio/wikidocs
as
- plain text
.md
markdown files - as single HTML and PDF file:
documentation.{html,pdf}
- HOME: This page. Landing Page of PhysIO Wiki. Navigation to all other files and this explanation.
- FAQ: Frequently asked questions (for users) (also frequently updated!)
- QUICKSTART: Example script and how to use it on test data, Intro to Batch Editor GUI
- EXAMPLES: List and explanation of all examples available for download
- Manual: Detailed overview of the toolbox functionality, sub-pages following its modular structure
- Read-In of Logfiles
- The following pages are under construction
- TODO Preprocessing Physiological Data
- TODO Physiological Noise Modeling
- TODO Performance Assessment
-
TODO Technical Documentation For developers, list of all functions, see header of
.m
files for now
Documentation for this toolbox is also provided in the following forms:
-
Overview and guide to further documentation: README.md and CHANGELOG.md
- README.md: purpose, installation, getting started, pointer to more help
- CHANGELOG.md: List of all toolbox versions and the respective release notes, i.e. major changes in functionality, bugfixes etc.
-
Within SPM: All toolbox parameters and their settings are explained in the Help Window of the SPM Batch Editor
-
Within Matlab: Extensive header at the start of each
tapas_physio_*
function and commenting- accessible via
help
anddoc
commands from Matlab command line - starting point for all parameters (comments within file):
edit tapas_physio_new
- also useful for developers (technical documentation)
- accessible via
-
Scientific Documentation: Our paper on the PhysIO Toolbox explains both the scientific background on physiological noise modeling, as well as the modular structure of the toolbox as comprehensivce yet succinct as we (and the reviewers) could.