Skip to content

Commit 84f0a8f

Browse files
authored
Update usage.rst to change from key group to entity set (#381)
* Update usage.rst Continue the change from Key Group to Entity Set * Update glossary.rst
1 parent 5e6c713 commit 84f0a8f

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Glossary
3030
in their respective Dominant Groups.
3131

3232
Acquisition Group
33-
A collection of sessions across participants that contains the exact same set of Key
33+
A collection of sessions across participants that contains the exact same set of Entity
3434
and Param Groups.
3535

3636

docs/usage.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Acquisition Group
6161
~~~~~~~~~~~~~~~~~
6262

6363
We define an :term:`Acquisition Group` as a collection of sessions across participants that
64-
contain the exact same set of Key and Parameter Groups.
64+
contain the exact same set of Entity and Parameter Groups.
6565
Since Entity Sets are based on the BIDS filenames—
6666
and therefore both MRI image type and acquisition specific—
6767
each BIDS session directory contains images that belong to a set of Parameter Groups.
@@ -104,12 +104,12 @@ The ``_files.tsv`` file
104104

105105
This file contains one row per imaging file in the BIDS directory.
106106
You won't need to edit this file directly,
107-
but it keeps track of every file's assignment to Key and Parameter Groups.
107+
but it keeps track of every file's assignment to Entity and Parameter Groups.
108108

109109

110110
.. _acqgrouptsv:
111111

112-
Modifying Key and Parameter Group Assignments
112+
Modifying Entity and Parameter Group Assignments
113113
---------------------------------------------
114114

115115
Sometimes we see that there are important differences in acquisition parameters within a Entity Set.
@@ -123,10 +123,10 @@ Once the columns have been edited you can apply the changes to BIDS data using
123123

124124
.. code-block:: console
125125
126-
$ cubids apply /bids/dir keyparam_edited new_keyparam_prefix
126+
$ cubids apply /bids/dir entityparam_edited new_entityparam_prefix
127127
128-
The changes in ``keyparam_edited_summary.csv`` will be applied to the BIDS data in ``/bids/dir``
129-
and the new Key and Parameter groups will be saved to csv files starting with ``new_keyparam_prefix``.
128+
The changes in ``entityparam_edited_summary.csv`` will be applied to the BIDS data in ``/bids/dir``
129+
and the new Entity and Parameter groups will be saved to csv files starting with ``new_entityparam_prefix``.
130130
Note: fieldmaps entitysets with variant parameters will be identified but not renamed.
131131

132132

@@ -216,7 +216,7 @@ In this example, users can apply the changes to BIDS data using the following co
216216
$ cubids apply FULL/PATH/TO/BIDS/DIR FULL/PATH/TO/v0_edited_summary.tsv FULL/PATH/TO/v0_files.tsv FULL/PATH/TO/v1
217217
218218
The changes in ``v0_edited_summary.tsv`` will be applied to the BIDS data
219-
and the new Key and Parameter Groups will be saved to tsv files starting with ``v1``.
219+
and the new Entity and Parameter Groups will be saved to tsv files starting with ``v1``.
220220

221221
Applying these changes we would see:
222222

0 commit comments

Comments
 (0)