Skip to content

Commit 1d98617

Browse files
authored
Merge pull request #778 from UNFmontreal/fix/pre-commit-all
run pre-commit on all files to avoid unrelated errors in other PRs.
2 parents 41b6d83 + 3675f05 commit 1d98617

File tree

4 files changed

+14
-17
lines changed

4 files changed

+14
-17
lines changed

docs/container.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Using heudiconv in a Container
44

55
If heudiconv is :ref:`installed via a Docker container <install_container>`, you
66
can run the commands in the following format::
7-
7+
88
docker run nipy/heudiconv:latest [heudiconv options]
99

1010
So a user running via container would check the version with this command::
@@ -46,4 +46,3 @@ We typically recommend users make use of the following flags to Docker and Podma
4646

4747
* ``-it`` Interactive terminal
4848
* ``--rm`` Remove the changes to the container when it completes
49-

docs/custom-heuristic.rst

-1
Original file line numberDiff line numberDiff line change
@@ -316,4 +316,3 @@ Suppose you want to use the values in the field ``image_type``? It is not a num
316316
Note that this differs from testing for a string because you cannot test for any substring (e.g., 'TEST' would not work). String tests will not work on a tuple datatype.
317317

318318
.. Note:: *image_type* is described in the `DICOM specification <https://dicom.innolitics.com/ciods/mr-image/general-image/00080008>`_
319-

docs/index.rst

-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ Contents
1919
commandline
2020
container
2121
api
22-

docs/quickstart.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ Quickstart
33

44
This tutorial is based on `Dianne Patterson's University of Arizona tutorials <https://neuroimaging-core-docs.readthedocs.io/en/latest/pages/heudiconv.html#lesson-3-reproin-py>`_
55

6-
This guide assumes you have already :ref:`installed heudiconv and dcm2niix <install_local>` and
6+
This guide assumes you have already :ref:`installed heudiconv and dcm2niix <install_local>` and
77
demonstrates how to use the heudiconv tool with a provided `heuristic.py` to convert DICOMS into the BIDS data structure.
88

99
.. _prepare_dataset:
1010

1111
Prepare Dataset
1212
***************
1313

14-
Download and unzip `sub-219_dicom.zip <https://datasets.datalad.org/?dir=/repronim/heudiconv-tutorial-example/>`_.
14+
Download and unzip `sub-219_dicom.zip <https://datasets.datalad.org/?dir=/repronim/heudiconv-tutorial-example/>`_.
1515

1616
We will be working from a directory called MRIS. Under the MRIS directory is the *dicom* subdirectory: Under the subject number *219* the session *itbs* is nested. Each dicom sequence folder is nested under the session::
1717

@@ -29,7 +29,7 @@ We will be working from a directory called MRIS. Under the MRIS directory is the
2929
├── field_mapping_21
3030
└── restingstate_18
3131
Nifti
32-
└── code
32+
└── code
3333
└── heuristic1.py
3434

3535
Basic Conversion
@@ -57,36 +57,36 @@ Run the following command::
5757

5858
Output
5959
******
60-
60+
6161
The *Nifti* directory will contain a bids-compliant subject directory::
62-
63-
62+
63+
6464
└── sub-219
6565
└── ses-itbs
6666
├── anat
6767
├── dwi
6868
├── fmap
6969
└── func
70-
70+
7171
The following required BIDS text files are also created in the Nifti directory. Details for filling in these skeleton text files can be found under `tabular files <https://bids-specification.readthedocs.io/en/stable/02-common-principles.html#tabular-files>`_ in the BIDS specification::
72-
72+
7373
CHANGES
7474
README
7575
dataset_description.json
7676
participants.json
7777
participants.tsv
7878
task-rest_bold.json
79-
79+
8080
Validation
8181
**********
8282

83-
Ensure that everything is according to spec by using `bids validator <https://bids-standard.github.io/bids-validator/>`_
83+
Ensure that everything is according to spec by using `bids validator <https://bids-standard.github.io/bids-validator/>`_
8484

8585
Click `Choose File` and then select the *Nifti* directory. There should be no errors (though there are a couple of warnings).
86-
86+
8787
.. Note:: Your files are not uploaded to the BIDS validator, so there are no privacy concerns!
88-
89-
Next
88+
89+
Next
9090
****
9191

9292
In the following sections, you will modify *heuristic.py* yourself so you can test different options and understand how to work with your own data.

0 commit comments

Comments
 (0)