Skip to content

Commit 9e4438a

Browse files
authored
Merge pull request #403 from mgxd/fix/report-boilerplate
FIX: Readd boilerplate, errors to report
2 parents 050a083 + e2a082c commit 9e4438a

File tree

1 file changed

+42
-96
lines changed

1 file changed

+42
-96
lines changed

nibabies/data/reports-spec.yml

Lines changed: 42 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -10,72 +10,44 @@ sections:
1010
desc: conform
1111
extension: [.html]
1212
- bids: {datatype: figures, suffix: dseg}
13-
caption: This panel shows the template anatomical image (if several were found),
14-
with contours delineating the detected brain mask and brain tissue
15-
segmentations.
13+
caption: This panel shows the template anatomical image (if several were found), with contours delineating the detected brain mask and brain tissue segmentations.
1614
subtitle: Brain mask and brain tissue segmentation of anatomical reference
1715
- bids: {datatype: figures, space: .*, suffix: T1w, regex_search: True}
18-
caption: Spatial normalization of the anatomical reference image to the <code>{space}</code>
19-
template.
20-
description: Results of nonlinear alignment of the anatomical reference one or more template
21-
space(s). Hover on the panels with the mouse pointer to transition between both
22-
spaces.
16+
caption: Spatial normalization of the anatomical reference image to the <code>{space}</code> template.
17+
description: Results of nonlinear alignment of the anatomical reference one or more template space(s). Hover on the panels with the mouse pointer to transition between both spaces.
2318
static: false
2419
subtitle: Spatial normalization of the anatomical reference
2520
- bids: {datatype: figures, desc: reconall, suffix: T1w}
26-
caption: Surfaces (white and pial) reconstructed with FreeSurfer (<code>recon-all</code>)
27-
overlaid on the participant's T1w template.
21+
caption: Surfaces (white and pial) reconstructed with FreeSurfer (<code>recon-all</code>) overlaid on the participant's T1w template.
2822
subtitle: Surface reconstruction
2923
- bids: {datatype: figures, desc: infantfs, suffix: T1w}
30-
caption: Surfaces (white and pial) reconstructed with FreeSurfer (<code>infant_recon_all</code>)
31-
overlaid on the participant's T1w template.
24+
caption: Surfaces (white and pial) reconstructed with FreeSurfer (<code>infant_recon_all</code>) overlaid on the participant's T1w template.
3225
subtitle: Surface reconstruction
3326
- bids: {datatype: figures, desc: mcribs, suffix: T2w}
34-
caption: Surfaces (white and pial) reconstructed with M-CRIB-S (<code>MCRIBReconAll</code>)
35-
overlaid on the participant's T2w template.
27+
caption: Surfaces (white and pial) reconstructed with M-CRIB-S (<code>MCRIBReconAll</code>) overlaid on the participant's T2w template.
3628
subtitle: Surface reconstruction
3729

3830
- name: <em>B<sub>0</sub></em> field mapping
3931
ordering: session,acquisition,run,fmapid
4032
reportlets:
4133
- bids: {datatype: figures, desc: mapped, suffix: fieldmap}
42-
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions
43-
along the phase-encoding direction of the image. Some scanners produce a <em>B<sub>0</sub></em>
44-
mapping of the field, using Spiral Echo Imaging (SEI) or postprocessing a "phase-difference"
45-
acquisition. The plot below shows an anatomical "magnitude" reference and the corresponding
46-
fieldmap.
47-
description: Hover over the panels with the mouse pointer to also visualize the intensity of the
48-
field inhomogeneity in Hertz.
34+
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions along the phase-encoding direction of the image. Some scanners produce a <em>B<sub>0</sub></em> mapping of the field, using Spiral Echo Imaging (SEI) or postprocessing a "phase-difference" acquisition. The plot below shows an anatomical "magnitude" reference and the corresponding fieldmap.
35+
description: Hover over the panels with the mouse pointer to also visualize the intensity of the field inhomogeneity in Hertz.
4936
static: false
5037
subtitle: "Preprocessed <em>B<sub>0</sub></em> mapping acquisition"
5138
- bids: {datatype: figures, desc: phasediff, suffix: fieldmap}
52-
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions
53-
along the phase-encoding direction of the image. A Gradient-Recalled Echo (GRE) scheme for the
54-
mapping of the <em>B<sub>0</sub></em> inhomogeneities by subtracting the phase maps obtained at
55-
two subsequent echoes. The plot below shows an anatomical "magnitude" reference and the corresponding
56-
fieldmap.
57-
description: Hover over the panels with the mouse pointer to also visualize the intensity of the
58-
field inhomogeneity in Hertz.
39+
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions along the phase-encoding direction of the image. A Gradient-Recalled Echo (GRE) scheme for the mapping of the <em>B<sub>0</sub></em> inhomogeneities by subtracting the phase maps obtained at two subsequent echoes. The plot below shows an anatomical "magnitude" reference and the corresponding fieldmap.
40+
description: Hover over the panels with the mouse pointer to also visualize the intensity of the field inhomogeneity in Hertz.
5941
static: false
6042
subtitle: "Preprocessed mapping of phase-difference acquisition"
6143
- bids: {datatype: figures, desc: pepolar, suffix: fieldmap}
62-
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions
63-
along the phase-encoding direction of the image. Utilizing two or more images with different
64-
phase-encoding polarities (PEPolar) or directions, it is possible to estimate the inhomogeneity
65-
of the field. The plot below shows a reference EPI (echo-planar imaging) volume generated
66-
using two or more EPI images with varying phase-encoding blips.
67-
description: Hover on the panels with the mouse pointer to also visualize the intensity of the
68-
inhomogeneity of the field in Hertz.
44+
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions along the phase-encoding direction of the image. Utilizing two or more images with different phase-encoding polarities (PEPolar) or directions, it is possible to estimate the inhomogeneity of the field. The plot below shows a reference EPI (echo-planar imaging) volume generated using two or more EPI images with varying phase-encoding blips.
45+
description: Hover on the panels with the mouse pointer to also visualize the intensity of the inhomogeneity of the field in Hertz.
6946
static: false
7047
subtitle: "Preprocessed estimation with varying Phase-Endocing (PE) blips"
7148
- bids: {datatype: figures, desc: anat, suffix: fieldmap}
72-
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions
73-
along the phase-encoding direction of the image. Utilizing an <em>anatomically-correct</em> acquisition
74-
(for instance, T1w or T2w), it is possible to estimate the inhomogeneity of the field by means of nonlinear
75-
registration. The plot below shows a reference EPI (echo-planar imaging) volume generated
76-
using two or more EPI images with the same PE encoding, after alignment to the anatomical scan.
77-
description: Hover on the panels with the mouse pointer to also visualize the intensity of the
78-
inhomogeneity of the field in Hertz.
49+
caption: Inhomogeneities of the <em>B<sub>0</sub></em> field introduce (oftentimes severe) spatial distortions along the phase-encoding direction of the image. Utilizing an <em>anatomically-correct</em> acquisition (for instance, T1w or T2w), it is possible to estimate the inhomogeneity of the field by means of nonlinear registration. The plot below shows a reference EPI (echo-planar imaging) volume generated using two or more EPI images with the same PE encoding, after alignment to the anatomical scan.
50+
description: Hover on the panels with the mouse pointer to also visualize the intensity of the inhomogeneity of the field in Hertz.
7951
static: false
8052
subtitle: "Preprocessed estimation by nonlinear registration to an anatomical scan (&ldquo;<em>fieldmap-less</em>&rdquo;)"
8153

@@ -85,90 +57,46 @@ sections:
8557
- bids: {datatype: figures, desc: summary, suffix: bold}
8658
- bids: {datatype: figures, desc: validation, suffix: bold}
8759
- bids: {datatype: figures, desc: fieldmap, suffix: bold}
88-
caption: The estimated fieldmap was aligned to the corresponding EPI reference
89-
with a rigid-registration process of the magintude part of the fieldmap,
90-
using <code>antsRegistration</code>.
91-
Overlaid on top of the co-registration results, the displacements along the
92-
phase-encoding direction are represented in arbitrary units.
93-
Please note that the color scale is centered around zero (i.e. full transparency),
94-
but the extremes might be different (i.e., the maximum of red colors could be
95-
orders of magnitude above or below the minimum of blue colors.)
60+
caption: The estimated fieldmap was aligned to the corresponding EPI reference with a rigid-registration process of the magintude part of the fieldmap, using <code>antsRegistration</code>. Overlaid on top of the co-registration results, the displacements along the phase-encoding direction are represented in arbitrary units. Please note that the color scale is centered around zero (i.e. full transparency), but the extremes might be different (i.e., the maximum of red colors could be orders of magnitude above or below the minimum of blue colors.)
9661
static: false
9762
subtitle: Estimated fieldmap and alignment to the corresponding EPI reference
9863
- bids: {datatype: figures, desc: sdc, suffix: bold}
99-
caption: Results of performing susceptibility distortion correction (SDC) on the
100-
EPI
64+
caption: Results of performing susceptibility distortion correction (SDC) on the EPI
10165
static: false
10266
subtitle: Susceptibility distortion correction
10367
- bids: {datatype: figures, desc: forcedsyn, suffix: bold}
104-
caption: The dataset contained some fieldmap information, but the argument <code>--force-syn</code>
105-
was used. The higher-priority SDC method was used. Here, we show the results
106-
of performing SyN-based SDC on the EPI for comparison.
68+
caption: The dataset contained some fieldmap information, but the argument <code>--force-syn</code> was used. The higher-priority SDC method was used. Here, we show the results of performing SyN-based SDC on the EPI for comparison.
10769
static: false
10870
subtitle: Experimental fieldmap-less susceptibility distortion correction
10971
- bids: {datatype: figures, desc: flirtnobbr, suffix: bold}
110-
caption: FSL <code>flirt</code> was used to generate transformations from EPI
111-
space to T1 Space - BBR refinement rejected. Note that Nearest Neighbor interpolation
112-
is used in the reportlets in order to highlight potential spin-history and other
113-
artifacts, whereas final images are resampled using Lanczos interpolation.
72+
caption: FSL <code>flirt</code> was used to generate transformations from EPI space to T1 Space - BBR refinement rejected. Note that Nearest Neighbor interpolation is used in the reportlets in order to highlight potential spin-history and other artifacts, whereas final images are resampled using Lanczos interpolation.
11473
static: false
11574
subtitle: Alignment of functional and anatomical MRI data (volume based)
11675
- bids: {datatype: figures, desc: coreg, suffix: bold}
117-
caption: <code>mri_coreg</code> (FreeSurfer) was used to generate transformations
118-
from EPI space to T1 Space - <code>bbregister</code> refinement rejected. Note
119-
that Nearest Neighbor interpolation is used in the reportlets in order to highlight
120-
potential spin-history and other artifacts, whereas final images are resampled
121-
using Lanczos interpolation.
76+
caption: <code>mri_coreg</code> (FreeSurfer) was used to generate transformations from EPI space to T1 Space - <code>bbregister</code> refinement rejected. Note that Nearest Neighbor interpolation is used in the reportlets in order to highlight potential spin-history and other artifacts, whereas final images are resampled using Lanczos interpolation.
12277
static: false
12378
subtitle: Alignment of functional and anatomical MRI data (volume based)
12479
- bids: {datatype: figures, desc: flirtbbr, suffix: bold}
125-
caption: FSL <code>flirt</code> was used to generate transformations from EPI-space
126-
to anatomical space - The white matter mask calculated with FSL <code>fast</code> (brain
127-
tissue segmentation) was used for BBR. Note that Nearest Neighbor interpolation
128-
is used in the reportlets in order to highlight potential spin-history and other
129-
artifacts, whereas final images are resampled using Lanczos interpolation.
80+
caption: FSL <code>flirt</code> was used to generate transformations from EPI-space to anatomical space - The white matter mask calculated with FSL <code>fast</code> (brain tissue segmentation) was used for BBR. Note that Nearest Neighbor interpolation is used in the reportlets in order to highlight potential spin-history and other artifacts, whereas final images are resampled using Lanczos interpolation.
13081
static: false
13182
subtitle: Alignment of functional and anatomical MRI data (surface driven)
13283
- bids: {datatype: figures, desc: bbregister, suffix: bold}
133-
caption: <code>bbregister</code> was used to generate transformations from EPI-space
134-
to anatomical space. Note that Nearest Neighbor interpolation is used in the reportlets
135-
in order to highlight potential spin-history and other artifacts, whereas final
136-
images are resampled using Lanczos interpolation.
84+
caption: <code>bbregister</code> was used to generate transformations from EPI-space to anatomical space. Note that Nearest Neighbor interpolation is used in the reportlets in order to highlight potential spin-history and other artifacts, whereas final images are resampled using Lanczos interpolation.
13785
static: false
13886
subtitle: Alignment of functional and anatomical MRI data (surface driven)
13987
- bids: {datatype: figures, desc: rois, suffix: bold}
140-
caption: Brain mask calculated on the BOLD signal (red contour), along with the
141-
regions of interest (ROIs) used in <em>a/tCompCor</em> for extracting
142-
physiological and movement confounding components.<br />
143-
The <em>anatomical CompCor</em> ROI (magenta contour) is a mask combining
144-
CSF and WM (white-matter), where voxels containing a minimal partial volume
145-
of GM have been removed.<br />
146-
The <em>temporal CompCor</em> ROI (blue contour) contains the top 2% most
147-
variable voxels within the brain mask.
88+
caption: Brain mask calculated on the BOLD signal (red contour), along with the regions of interest (ROIs) used in <em>a/tCompCor</em> for extracting physiological and movement confounding components.<br /> The <em>anatomical CompCor</em> ROI (magenta contour) is a mask combining CSF and WM (white-matter), where voxels containing a minimal partial volume of GM have been removed.<br /> The <em>temporal CompCor</em> ROI (blue contour) contains the top 2% most variable voxels within the brain mask.
14889
subtitle: Brain mask and (anatomical/temporal) CompCor ROIs
14990
- bids:
15091
datatype: figures
15192
desc: '[at]compcor'
15293
extension: [.html]
15394
suffix: bold
15495
- bids: {datatype: figures, desc: 'compcorvar', suffix: bold}
155-
caption: The cumulative variance explained by the first k components of the
156-
<em>t/aCompCor</em> decomposition, plotted for all values of <em>k</em>.
157-
The number of components that must be included in the model in order to
158-
explain some fraction of variance in the decomposition mask can be used
159-
as a feature selection criterion for confound regression.
96+
caption: The cumulative variance explained by the first k components of the <em>t/aCompCor</em> decomposition, plotted for all values of <em>k</em>. The number of components that must be included in the model in order to explain some fraction of variance in the decomposition mask can be used as a feature selection criterion for confound regression.
16097
subtitle: Variance explained by t/aCompCor components
16198
- bids: {datatype: figures, desc: carpetplot, suffix: bold}
162-
caption: Summary statistics are plotted, which may reveal trends or artifacts
163-
in the BOLD data. Global signals calculated within the whole-brain (GS), within
164-
the white-matter (WM) and within cerebro-spinal fluid (CSF) show the mean BOLD
165-
signal in their corresponding masks. DVARS and FD show the standardized DVARS
166-
and framewise-displacement measures for each time point.<br />
167-
A carpet plot shows the time series for all voxels within the brain mask,
168-
or if <code>--cifti-output</code> was enabled, all grayordinates.
169-
Voxels are grouped into cortical (dark/light blue), and subcortical (orange)
170-
gray matter, cerebellum (green) and white matter and CSF
171-
(red), indicated by the color map on the left-hand side.
99+
caption: Summary statistics are plotted, which may reveal trends or artifacts in the BOLD data. Global signals calculated within the whole-brain (GS), within the white-matter (WM) and within cerebro-spinal fluid (CSF) show the mean BOLD signal in their corresponding masks. DVARS and FD show the standardized DVARS and framewise-displacement measures for each time point.<br /> A carpet plot shows the time series for all voxels within the brain mask, or if <code>--cifti-output</code> was enabled, all grayordinates. Voxels are grouped into cortical (dark/light blue), and subcortical (orange) gray matter, cerebellum (green) and white matter and CSF (red), indicated by the color map on the left-hand side.
172100
subtitle: BOLD Summary
173101
- bids: {datatype: figures, desc: 'confoundcorr', suffix: bold}
174102
caption: |
@@ -180,5 +108,23 @@ sections:
180108
confound regression.
181109
subtitle: Correlations among nuisance regressors
182110
- name: About
111+
nested: true
183112
reportlets:
184113
- bids: {datatype: figures, desc: about}
114+
- custom: boilerplate
115+
path: '{out_dir}/logs'
116+
bibfile: ['nibabies', 'data/boilerplate.bib']
117+
caption: |
118+
<p>We kindly ask to report results preprocessed with this tool using the following boilerplate.</p>
119+
<p class="alert alert-info" role="alert">
120+
<strong>Copyright Waiver</strong>.
121+
The boilerplate text was automatically generated by <em>NiReports</em> with the
122+
express intention that users should copy and paste this text into their manuscripts <em>unchanged</em>.
123+
It is released under the
124+
<a href="https://creativecommons.org/publicdomain/zero/1.0/" target="_blank">CC0 license</a>.
125+
</p>
126+
title: Methods
127+
- custom: errors
128+
path: '{out_dir}/sub-{subject}/log/{run_uuid}'
129+
captions: <em>NiReports</em> may have recorded failure conditions.
130+
title: Errors

0 commit comments

Comments
 (0)