Skip to content

Commit b07d252

Browse files
committed
Fixed links.
1 parent 5191e8c commit b07d252

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

doc/users/grabbing_and_sinking.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ DataGrabber and DataSink explained
55
==================================
66

77
In this chapter we will try to explain the concepts behind DataGrabber and
8-
DataSink.
8+
:ref:`DataSink <nipype.interfaces.io.DataSink>`.
99

1010
Why do we need these interfaces?
1111
================================
@@ -39,7 +39,7 @@ However, in the context of complex workflows and given that users typically
3939
arrange their imaging and other data in a semantically hierarchical data store,
4040
an alternative mechanism for reading and writing the data generated by a workflow
4141
is often necessary. As the names suggest DataGrabber is used to get at data
42-
stored in a shared file system while DataSink is used to store the data
42+
stored in a shared file system while :ref:`DataSink <nipype.interfaces.io.DataSink>` is used to store the data
4343
generated by a workflow into a hierarchical structure on disk.
4444

4545

@@ -145,15 +145,15 @@ information such as execution reports, hashfiles determining the input state of
145145
processes. All of this is embedded in a hierarchical structure that reflects the
146146
iterables that have been used in the workflow. This makes navigating the working
147147
directory a not so pleasant experience. And typically the user is interested in
148-
preserving only a small percentage of these outputs. The DataSink interface can
148+
preserving only a small percentage of these outputs. The :ref:`DataSink <nipype.interfaces.io.DataSink>` interface can
149149
be used to extract components from this `cache` and store it at a different
150-
location. For XNAT-based storage, see :ref:`nipype.interfaces.io.XNATSink` .
150+
location. For XNAT-based storage, see :ref:`XNATSink <nipype.interfaces.io.XNATSink>` .
151151

152152
.. note::
153153

154-
Unlike other interfaces, a DataSink's inputs are defined and created by using
154+
Unlike other interfaces, a :ref:`DataSink <nipype.interfaces.io.DataSink>`'s inputs are defined and created by using
155155
the workflow connect statement. Currently disconnecting an input from the
156-
datasink does not remove that connection port.
156+
:ref:`DataSink <nipype.interfaces.io.DataSink>` does not remove that connection port.
157157

158158
Let's assume we have the following workflow.
159159

@@ -162,7 +162,7 @@ Let's assume we have the following workflow.
162162
"InputNode" -> "Realign" -> "DataSink";
163163
"InputNode" -> "DataSink";
164164

165-
The following code segment defines the DataSink node and sets the `base_directory`
165+
The following code segment defines the :ref:`DataSink <nipype.interfaces.io.DataSink>` node and sets the `base_directory`
166166
in which all outputs will be stored. The `container` input creates a
167167
subdirectory within the `base_directory`. If you are iterating a workflow over
168168
subjects, it may be useful to save it within a folder with the subject id.
@@ -191,16 +191,16 @@ we need to create a second port. We can store the files in a separate folder.
191191

192192
The period (.) indicates that a subfolder called par should be created. But if
193193
we wanted to store it in the same folder as the realigned files, we would use
194-
the `.@` syntax. The @ tells the datasink interface to not create the
195-
subfolder. This will allow us to create different named input ports for datasink
194+
the `.@` syntax. The @ tells the :ref:`DataSink <nipype.interfaces.io.DataSink>` interface to not create the
195+
subfolder. This will allow us to create different named input ports for :ref:`DataSink <nipype.interfaces.io.DataSink>`
196196
and allow the user to store the files in the same folder.
197197

198198
::
199199

200200
workflow.connect(realigner, 'realigned_files', datasink, 'motion')
201201
workflow.connect(realigner, 'realignment_parameters', datasink, 'motion.@par')
202202

203-
The syntax for the input port of DataSink takes the following form:
203+
The syntax for the input port of :ref:`DataSink <nipype.interfaces.io.DataSink>` takes the following form:
204204

205205
::
206206

@@ -210,7 +210,7 @@ The syntax for the input port of DataSink takes the following form:
210210
MapNode
211211
-------
212212

213-
In order to use :ref:`nipype.interfaces.io.DataSink` inside a MapNode, it's
213+
In order to use :ref:`DataSink <nipype.interfaces.io.DataSink>` inside a MapNode, it's
214214
inputs have to be defined inside the constructor using the `infields` keyword
215215
arg.
216216

@@ -222,7 +222,7 @@ over various inputs using the iterables attribute of nodes. This means that a
222222
given workflow can have multiple outputs depending on how many iterables are
223223
there. Iterables create working directory subfolders such as
224224
`_iterable_name_value`. The `parameterization` input parameter controls whether
225-
the data stored using DataSink is in a folder structure that contains this
225+
the data stored using :ref:`DataSink <nipype.interfaces.io.DataSink>` is in a folder structure that contains this
226226
iterable information or not. It is generally recommended to set this to `True`
227227
when using multiple nested iterables.
228228

doc/users/mapnode_and_iterables.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,6 @@ Iterables are commonly used to execute the same workflow for many subjects.
142142
Usually one parametrises DataGrabber node with subject ID. This is achieved by
143143
connecting an IdentityInterface in front of DataGrabber. When you set iterables of the
144144
IdentityInterface to the list of subjects IDs, the same workflow will be executed
145-
for every subject. See :doc:`examples/spm_tutorial` to see this pattern in action.
145+
for every subject. See :doc:`examples/fmri_spm` to see this pattern in action.
146146

147147
.. include:: ../links_names.txt

0 commit comments

Comments
 (0)