Skip to content

Commit

Permalink
doc updates [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Circle Ci committed Dec 7, 2023
1 parent 0c9fca5 commit b09d116
Show file tree
Hide file tree
Showing 19 changed files with 94 additions and 94 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a45f11a6cfb1de791052d41fb2dfb979
config: d860fb2645abdadde623263bde837605
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
62 changes: 31 additions & 31 deletions dev/auto_examples/anonymize_dataset.html
Original file line number Diff line number Diff line change
Expand Up @@ -688,18 +688,18 @@ <h2>Basic anonymization<a class="headerlink" href="#basic-anonymization" title="
Input: /home/circleci/mne_data/MNE-sample-data-bids
Output: /home/circleci/mne_data/MNE-sample-data-bids-anon

Shifting recording dates by 34080 days (93.4 years).
Shifting recording dates by 30826 days (84.5 years).
Using the following subject ID anonymization mapping:

sub-ABC123 → sub-1
sub-emptyroom → sub-emptyroom


0%| | Anonymizing : 0/5 [00:00&lt;?, ?it/s]
20%|██ | Anonymizing : 1/5 [00:00&lt;00:01, 3.59it/s]
40%|████ | Anonymizing : 2/5 [00:02&lt;00:03, 1.23s/it]
60%|██████ | Anonymizing : 3/5 [00:03&lt;00:02, 1.05s/it]
100%|██████████| Anonymizing : 5/5 [00:03&lt;00:00, 1.59it/s]
20%|██ | Anonymizing : 1/5 [00:00&lt;00:01, 2.48it/s]
40%|████ | Anonymizing : 2/5 [00:03&lt;00:04, 1.64s/it]
60%|██████ | Anonymizing : 3/5 [00:04&lt;00:02, 1.44s/it]
100%|██████████| Anonymizing : 5/5 [00:04&lt;00:00, 1.17it/s]
</pre></div>
</div>
<p>That’s it! Let’s have a look at directory structure of the anonymized
Expand Down Expand Up @@ -727,12 +727,12 @@ <h2>Basic anonymization<a class="headerlink" href="#basic-anonymization" title="
|--------- sub-1_task-audiovisual_meg.fif
|--------- sub-1_task-audiovisual_meg.json
|--- sub-emptyroom/
|------ ses-19090816/
|--------- sub-emptyroom_ses-19090816_scans.tsv
|------ ses-19180714/
|--------- sub-emptyroom_ses-19180714_scans.tsv
|--------- meg/
|------------ sub-emptyroom_ses-19090816_task-noise_channels.tsv
|------------ sub-emptyroom_ses-19090816_task-noise_meg.fif
|------------ sub-emptyroom_ses-19090816_task-noise_meg.json
|------------ sub-emptyroom_ses-19180714_task-noise_channels.tsv
|------------ sub-emptyroom_ses-19180714_task-noise_meg.fif
|------------ sub-emptyroom_ses-19180714_task-noise_meg.json
</pre></div>
</div>
<p>You can see that the subject ID was changed to a number (in this case, the
Expand Down Expand Up @@ -770,8 +770,8 @@ <h2>Limiting to specific data types<a class="headerlink" href="#limiting-to-spec


0%| | Anonymizing : 0/1 [00:00&lt;?, ?it/s]
100%|██████████| Anonymizing : 1/1 [00:02&lt;00:00, 2.12s/it]
100%|██████████| Anonymizing : 1/1 [00:02&lt;00:00, 2.12s/it]
100%|██████████| Anonymizing : 1/1 [00:02&lt;00:00, 2.81s/it]
100%|██████████| Anonymizing : 1/1 [00:02&lt;00:00, 2.81s/it]
|MNE-sample-data-bids-anon/
|--- README
|--- dataset_description.json
Expand Down Expand Up @@ -813,9 +813,9 @@ <h2>Specifying time shift<a class="headerlink" href="#specifying-time-shift" tit


0%| | Anonymizing : 0/4 [00:00&lt;?, ?it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:00, 3.58it/s]
50%|█████ | Anonymizing : 2/4 [00:01&lt;00:01, 1.96it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 3.94it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:01, 2.56it/s]
50%|█████ | Anonymizing : 2/4 [00:01&lt;00:01, 1.37it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 2.76it/s]
|sub-emptyroom/
|--- ses-20021126/
|------ sub-emptyroom_ses-20021126_scans.tsv
Expand Down Expand Up @@ -853,17 +853,17 @@ <h2>Specifying subject IDs<a class="headerlink" href="#specifying-subject-ids" t
Input: /home/circleci/mne_data/MNE-sample-data-bids
Output: /home/circleci/mne_data/MNE-sample-data-bids-anon

Shifting recording dates by 32293 days (88.5 years).
Shifting recording dates by 28593 days (78.3 years).
Using the following subject ID anonymization mapping:

sub-ABC123 → sub-anonymous
sub-emptyroom → sub-emptyroom


0%| | Anonymizing : 0/4 [00:00&lt;?, ?it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:00, 3.71it/s]
50%|█████ | Anonymizing : 2/4 [00:00&lt;00:01, 1.99it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 4.00it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:01, 2.50it/s]
50%|█████ | Anonymizing : 2/4 [00:01&lt;00:01, 1.36it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 2.73it/s]
|MNE-sample-data-bids-anon/
|--- README
|--- dataset_description.json
Expand All @@ -881,12 +881,12 @@ <h2>Specifying subject IDs<a class="headerlink" href="#specifying-subject-ids" t
|--------- sub-anonymous_task-audiovisual_meg.fif
|--------- sub-anonymous_task-audiovisual_meg.json
|--- sub-emptyroom/
|------ ses-19140708/
|--------- sub-emptyroom_ses-19140708_scans.tsv
|------ ses-19240824/
|--------- sub-emptyroom_ses-19240824_scans.tsv
|--------- meg/
|------------ sub-emptyroom_ses-19140708_task-noise_channels.tsv
|------------ sub-emptyroom_ses-19140708_task-noise_meg.fif
|------------ sub-emptyroom_ses-19140708_task-noise_meg.json
|------------ sub-emptyroom_ses-19240824_task-noise_channels.tsv
|------------ sub-emptyroom_ses-19240824_task-noise_meg.fif
|------------ sub-emptyroom_ses-19240824_task-noise_meg.json
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -943,9 +943,9 @@ <h2>Reproducibility<a class="headerlink" href="#reproducibility" title="Link to


0%| | Anonymizing : 0/4 [00:00&lt;?, ?it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:00, 3.43it/s]
50%|█████ | Anonymizing : 2/4 [00:01&lt;00:01, 1.93it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 3.88it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:01, 2.53it/s]
50%|█████ | Anonymizing : 2/4 [00:01&lt;00:01, 1.36it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 2.74it/s]
|MNE-sample-data-bids-anon/
|--- README
|--- dataset_description.json
Expand Down Expand Up @@ -988,9 +988,9 @@ <h2>Reproducibility<a class="headerlink" href="#reproducibility" title="Link to


0%| | Anonymizing : 0/4 [00:00&lt;?, ?it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:00, 3.33it/s]
50%|█████ | Anonymizing : 2/4 [00:01&lt;00:01, 1.93it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 3.88it/s]
25%|██▌ | Anonymizing : 1/4 [00:00&lt;00:01, 2.15it/s]
50%|█████ | Anonymizing : 2/4 [00:01&lt;00:01, 1.32it/s]
100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00, 2.65it/s]
|MNE-sample-data-bids-anon/
|--- README
|--- dataset_description.json
Expand All @@ -1016,7 +1016,7 @@ <h2>Reproducibility<a class="headerlink" href="#reproducibility" title="Link to
|------------ sub-emptyroom_ses-19221211_task-noise_meg.json
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 11.044 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 15.357 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-anonymize-dataset-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/6a8efa177441ca0b84ef1b16e3806949/anonymize_dataset.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">anonymize_dataset.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/bidspath.html
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@
<p>By default, most MNE-BIDS functions will try to infer to correct
suffix and extension for your data, and you don’t need to specify them
manually.</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.005 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.007 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-bidspath-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">bidspath.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/convert_eeg_to_bids.html
Original file line number Diff line number Diff line change
Expand Up @@ -1143,7 +1143,7 @@ <h2>Cite mne-bids<a class="headerlink" href="#cite-mne-bids" title="Link to this
command line tool:</p>
<p>Web version: <a class="reference external" href="https://bids-standard.github.io/bids-validator/">https://bids-standard.github.io/bids-validator/</a></p>
<p>Command line tool: <a class="reference external" href="https://www.npmjs.com/package/bids-validator">https://www.npmjs.com/package/bids-validator</a></p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.596 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.861 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-convert-eeg-to-bids-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/0bc5481d861907f3ba86dd37d953b980/convert_eeg_to_bids.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">convert_eeg_to_bids.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/convert_empty_room.html
Original file line number Diff line number Diff line change
Expand Up @@ -884,7 +884,7 @@
&lt;Raw | sub-emptyroom_ses-20021204_task-noise_meg.fif, 315 x 66068 (110.0 s), ~354 kB, data not loaded&gt;
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.844 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.618 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-convert-empty-room-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/58cece9c8037ffebaaad2703d5ce7839/convert_empty_room.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">convert_empty_room.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/convert_group_studies.html
Original file line number Diff line number Diff line change
Expand Up @@ -967,7 +967,7 @@
0.0 were removed from analysis).
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.126 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 3.055 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-convert-group-studies-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/241c30601b8e062b34a8b85829a39a45/convert_group_studies.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">convert_group_studies.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/convert_ieeg_to_bids.html
Original file line number Diff line number Diff line change
Expand Up @@ -1492,7 +1492,7 @@ <h2>Step 5: Store coordinates in a template space<a class="headerlink" href="#st
recommend, if at all possible, saving BIDS iEEG data in ACPC coordinate space
corresponding to the individual subject’s brain, not in a template
coordinate frame.</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 5.117 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 6.675 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-convert-ieeg-to-bids-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/cf640e6bfa39f55978e620ef4269fd4c/convert_ieeg_to_bids.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">convert_ieeg_to_bids.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/convert_mne_sample.html
Original file line number Diff line number Diff line change
Expand Up @@ -1143,7 +1143,7 @@
</pre></div>
</div>
<p>This should be very similar to the <a class="reference external" href="https://github.com/sappelhoff/bids-examples/blob/master/ds000248/dataset_description.json">ds000248 dataset_description.json</a>!</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 3.687 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 5.549 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-convert-mne-sample-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/529f3230e5683b7676557bd33b2ea01b/convert_mne_sample.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">convert_mne_sample.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/convert_mri_and_trans.html
Original file line number Diff line number Diff line change
Expand Up @@ -983,7 +983,7 @@ <h2>Using manual landmark coordinates in scanner RAS<a class="headerlink" href="
<img src="../_images/sphx_glr_convert_mri_and_trans_004.png" srcset="../_images/sphx_glr_convert_mri_and_trans_004.png" alt="convert mri and trans" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>Writing &#39;/home/circleci/mne_data/MNE-sample-data-bids/sub-01/ses-01/anat/sub-01_ses-01_FLASH.json&#39;...
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 28.728 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 39.116 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-convert-mri-and-trans-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/9160181635ad137cb4a8a5779295596c/convert_mri_and_trans.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">convert_mri_and_trans.ipynb</span></code></a></p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/convert_nirs_to_bids.html
Original file line number Diff line number Diff line change
Expand Up @@ -1143,7 +1143,7 @@ <h2>Cite mne-bids<a class="headerlink" href="#cite-mne-bids" title="Link to this
command line tool:</p>
<p>Web version: <a class="reference external" href="https://bids-standard.github.io/bids-validator/">https://bids-standard.github.io/bids-validator/</a></p>
<p>Command line tool: <a class="reference external" href="https://www.npmjs.com/package/bids-validator">https://www.npmjs.com/package/bids-validator</a></p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.296 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.437 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-convert-nirs-to-bids-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/b666106ea850b55fb6bc69db6fdda679/convert_nirs_to_bids.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">convert_nirs_to_bids.ipynb</span></code></a></p>
Expand Down
Loading

0 comments on commit b09d116

Please sign in to comment.