Skip to content

Commit 107ad50

Browse files
committed
Improved documentation
1 parent d699aab commit 107ad50

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/advanced.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Generally speaking, a bidsmap file contains a collection of key-value dictionari
1414

1515
To create your own template bidsmap you can best first make a copy of the default template (``[path_to_bidscoin]/heuristics/bidsmap_template.yaml``) or of the DCCN example template (``[path_to_bidscoin]/heuristics/bidsmap_dccn.yaml``) and customize that bidsmap to your needs:
1616

17-
1. **Using the bidseditor**. This is the easiest way to create a bidsmap template since it uses only a GUI and doesn't require in-depth knowledge of bidsmaps and YAML files. If you have a run item in your study that you would like to be automatically mapped in other / future studies you can simply append that run to the standard or to a custom template bidsmap by editting it to your needs and click the ``Export`` button (see below). With the GUI you can still use advanced features, such as `Unix shell-style wildcards <https://docs.python.org/3/library/fnmatch.html>`__ in the values of the source attributes (see left panel), or such as using lists of attribute values (of which either one can match), or simply empty field to ignore the item. The main limitation of using the GUI is that the run items are always appended to a bidsmap template, meaning that they are last in line and will be used only if no other item in the template matches. It also means that like this you cannot edit the already existing run items in the bidsmap. Another smaller limitation is that with the GUI you cannot make usage of YAML anchors and references. Both these limitations are overcome when directly editting the template bidsmap yourself using a text editor (see next point).
17+
1. **Using the bidseditor**. This is the easiest way to create a bidsmap template since it uses only a GUI and doesn't require in-depth knowledge of bidsmaps and YAML files. If you have a run item in your study that you would like to be automatically mapped in other / future studies you can simply append that run to the standard or to a custom template bidsmap by editting it to your needs and click the ``Export`` button (see below). With the GUI you can still use advanced features, such as `Unix shell-style wildcards <https://docs.python.org/3/library/fnmatch.html>`__ in the values of the source attributes (see left panel), or such as using lists of attribute values (of which either one can match), or simply empty field to ignore the item. The main limitation of using the GUI is that the run items are always appended to a bidsmap template, meaning that they are last in line and will be used only if no other item in the template matches. It also means that like this you cannot edit the already existing run items in the bidsmap. Another (smaller) limitation is that with the GUI you cannot make usage of YAML anchors and references. Both limitations are overcome when directly editting the template bidsmap yourself using a text editor (see next point).
1818

1919
.. figure:: ./_static/bidseditor_edit.png
2020

0 commit comments

Comments
 (0)