Skip to content

Commit

Permalink
Add phys2bids -h description to howto.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
drombas authored Jan 28, 2021
1 parent 286ba44 commit d300712
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
How to use ``phys2bids``
========================

To use ``phys2bids`` you just need to run phys2bids command followed by a set of arguments. Depending on the utility you want to use these arguments will differ. A helping description of all possible arguments can be found `here <cli.html>`_ or by simply running:

.. code-block:: shell
phys2bids -h
This tutorial uses a text file exported from LabChart software. The principles of this tutorial apply for other inputs that ``phys2bids`` currently supports (AcqKnowledge native files and text files). However, future tutorials will go into the specifics of processing different inputs, as well as inputs which contain different sampling frequencies across data columns and inputs with multiple scans within one file.

This tutorial will:
Expand Down

0 comments on commit d300712

Please sign in to comment.