Skip to content

Commit

Permalink
More improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo committed Jan 31, 2024
1 parent 62862fe commit 6b8e588
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
5 changes: 2 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ initialize a new conda environment (for example, named ``cubids``) as follows:

.. code-block:: console
$ conda create -n cubids python=3.8
$ conda create -n cubids python=3.8 pip
$ conda activate cubids
You are now ready to install CuBIDS.
Expand All @@ -43,7 +43,6 @@ Once you have a copy of the source, you can install it with:
$ cd CuBIDS
$ pip install -e .
We will now need to install some dependencies of ``CuBIDS``.
To do this, we first must install nodejs.
We can accomplish this using the following command:
Expand All @@ -52,7 +51,7 @@ We can accomplish this using the following command:
$ conda install nodejs
Now that we have npm installed, we can install the ``bids-validator`` using the following command:
Now that we have npm installed, we can install ``bids-validator`` using the following command:

.. code-block:: console
Expand Down
17 changes: 6 additions & 11 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Key Group

A *Key Group* is a unique set of BIDS key-value pairs, excluding identifiers such as
subject and session.
For example the files::
For example, the files::

bids-root/sub-1/ses-1/func/sub-1_ses-1_acq-mb_dir-PA_task-rest_bold.nii.gz
bids-root/sub-1/ses-2/func/sub-1_ses-2_acq-mb_dir_PA_task-rest_bold.nii.gz
Expand All @@ -30,7 +30,7 @@ this naming convention would suffice.

However, in large multi-scanner, multi-site,
or longitudinal studies where acquisition parameters change over time,
it's possible that the same Key Group could comprise scans that differ in important ways.
it's possible that the same Key Group could contain scans that differ in important ways.

``CuBIDS`` examines all acquisitions within a Key Group to see if there are any images
that differ in a set of important acquisition parameters.
Expand All @@ -52,15 +52,6 @@ there can be detrimental consequences downstream if the different parameters cau
same preprocessing pipelines to configure differently to images of the same Key Group.


Acquisition Group
~~~~~~~~~~~~~~~~~

Acquisition Groups are sets of subjects whose images belong to all the same Key and Parameter Groups.
The Acquisition Groups that subjects belong to are listed in ``_AcqGrouping.csv``,
while the Key Groups and Parameter Groups that define each Acquisition Group are noted in
``_AcqGroupingInfo.txt``.


.. _acquisitiongroup:

Acquisition Group
Expand All @@ -80,6 +71,10 @@ They are also useful for expediting the testing of pipelines;
if a BIDS App runs successfully on a single subject from each Acquisition Group,
one can be confident that it will handle all combinations of scanning parameters in the entire dataset.

The Acquisition Groups that subjects belong to are listed in ``_AcqGrouping.csv``,
while the Key Groups and Parameter Groups that define each Acquisition Group are noted in
``_AcqGroupingInfo.txt``.


.. _summaryfile:

Expand Down

0 comments on commit 6b8e588

Please sign in to comment.