doc updates [skip ci]

dev/.buildinfo

@@ -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: 44192efb565aa49c3b07ca116dc177a5
+config: ff6e873c3173e6a9229654c8de78e421
 tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_modules/index.html

@@ -560,7 +560,7 @@ <h1>All modules for which code is available</h1>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/copyfiles.html

@@ -1197,7 +1197,7 @@ <h1>Source code for mne_bids.copyfiles</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/dig.html

@@ -1345,7 +1345,7 @@ <h1>Source code for mne_bids.dig</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/inspect.html

@@ -1008,7 +1008,7 @@ <h1>Source code for mne_bids.inspect</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/path.html

@@ -3046,7 +3046,7 @@ <h1>Source code for mne_bids.path</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/read.html

@@ -1707,7 +1707,7 @@ <h1>Source code for mne_bids.read</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/report/_report.html

@@ -1091,7 +1091,7 @@ <h1>Source code for mne_bids.report._report</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/sidecar_updates.html

@@ -942,7 +942,7 @@ <h1>Source code for mne_bids.sidecar_updates</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/stats.html

@@ -677,7 +677,7 @@ <h1>Source code for mne_bids.stats</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/utils.html

@@ -1095,7 +1095,7 @@ <h1>Source code for mne_bids.utils</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/_modules/mne_bids/write.html

@@ -3678,7 +3678,7 @@ <h1>Source code for mne_bids.write</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/api.html

@@ -770,7 +770,7 @@ <h2>mne_bids.copyfiles<a class="headerlink" href="#mne-bids-copyfiles" title="Pe
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/authors.html

@@ -568,7 +568,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/auto_examples/anonymize_dataset.html

@@ -672,18 +672,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 29183 days (80.0 years).
+Shifting recording dates by 35943 days (98.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.22s/it]
- 60%|██████    | Anonymizing : 3/5 [00:03&lt;00:02,    1.04s/it]
-100%|██████████| Anonymizing : 5/5 [00:03&lt;00:00,    1.61it/s]
+ 20%|██        | Anonymizing : 1/5 [00:00&lt;00:01,    3.02it/s]
+ 40%|████      | Anonymizing : 2/5 [00:02&lt;00:03,    1.29s/it]
+ 60%|██████    | Anonymizing : 3/5 [00:03&lt;00:02,    1.10s/it]
+100%|██████████| Anonymizing : 5/5 [00:03&lt;00:00,    1.52it/s]
 </pre></div>
 </div>
 <p>That’s it! Let’s have a look at directory structure of the anonymized
@@ -711,12 +711,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-19230112/
-|--------- sub-emptyroom_ses-19230112_scans.tsv
+|------ ses-19040710/
+|--------- sub-emptyroom_ses-19040710_scans.tsv
 |--------- meg/
-|------------ sub-emptyroom_ses-19230112_task-noise_channels.tsv
-|------------ sub-emptyroom_ses-19230112_task-noise_meg.fif
-|------------ sub-emptyroom_ses-19230112_task-noise_meg.json
+|------------ sub-emptyroom_ses-19040710_task-noise_channels.tsv
+|------------ sub-emptyroom_ses-19040710_task-noise_meg.fif
+|------------ sub-emptyroom_ses-19040710_task-noise_meg.json
 </pre></div>
 </div>
 <p>You can see that the subject ID was changed to a number (in this case, the
@@ -754,8 +754,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.19s/it]
+100%|██████████| Anonymizing : 1/1 [00:02&lt;00:00,    2.19s/it]
 |MNE-sample-data-bids-anon/
 |--- README
 |--- dataset_description.json
@@ -797,9 +797,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.24it/s]
- 50%|█████     | Anonymizing : 2/4 [00:01&lt;00:01,    1.96it/s]
-100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00,    3.93it/s]
+ 25%|██▌       | Anonymizing : 1/4 [00:00&lt;00:01,    2.87it/s]
+ 50%|█████     | Anonymizing : 2/4 [00:01&lt;00:01,    1.82it/s]
+100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00,    3.64it/s]
 |sub-emptyroom/
 |--- ses-20021126/
 |------ sub-emptyroom_ses-20021126_scans.tsv
@@ -837,17 +837,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 35928 days (98.4 years).
+Shifting recording dates by 35190 days (96.4 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.65it/s]
- 50%|█████     | Anonymizing : 2/4 [00:00&lt;00:00,    2.05it/s]
-100%|██████████| Anonymizing : 4/4 [00:00&lt;00:00,    4.11it/s]
+ 25%|██▌       | Anonymizing : 1/4 [00:00&lt;00:01,    2.94it/s]
+ 50%|█████     | Anonymizing : 2/4 [00:01&lt;00:01,    1.82it/s]
+100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00,    3.65it/s]
 |MNE-sample-data-bids-anon/
 |--- README
 |--- dataset_description.json
@@ -865,12 +865,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-19040725/
-|--------- sub-emptyroom_ses-19040725_scans.tsv
+|------ ses-19060802/
+|--------- sub-emptyroom_ses-19060802_scans.tsv
 |--------- meg/
-|------------ sub-emptyroom_ses-19040725_task-noise_channels.tsv
-|------------ sub-emptyroom_ses-19040725_task-noise_meg.fif
-|------------ sub-emptyroom_ses-19040725_task-noise_meg.json
+|------------ sub-emptyroom_ses-19060802_task-noise_channels.tsv
+|------------ sub-emptyroom_ses-19060802_task-noise_meg.fif
+|------------ sub-emptyroom_ses-19060802_task-noise_meg.json
 </pre></div>
 </div>
 </section>
@@ -927,9 +927,9 @@ <h2>Reproducibility<a class="headerlink" href="#reproducibility" title="Permalin
 
 
   0%|          | Anonymizing : 0/4 [00:00&lt;?,       ?it/s]
- 25%|██▌       | Anonymizing : 1/4 [00:00&lt;00:00,    3.62it/s]
- 50%|█████     | Anonymizing : 2/4 [00:00&lt;00:00,    2.04it/s]
-100%|██████████| Anonymizing : 4/4 [00:00&lt;00:00,    4.10it/s]
+ 25%|██▌       | Anonymizing : 1/4 [00:00&lt;00:01,    2.88it/s]
+ 50%|█████     | Anonymizing : 2/4 [00:01&lt;00:01,    1.76it/s]
+100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00,    3.54it/s]
 |MNE-sample-data-bids-anon/
 |--- README
 |--- dataset_description.json
@@ -972,9 +972,9 @@ <h2>Reproducibility<a class="headerlink" href="#reproducibility" title="Permalin
 
 
   0%|          | Anonymizing : 0/4 [00:00&lt;?,       ?it/s]
- 25%|██▌       | Anonymizing : 1/4 [00:00&lt;00:00,    3.56it/s]
- 50%|█████     | Anonymizing : 2/4 [00:00&lt;00:00,    2.04it/s]
-100%|██████████| Anonymizing : 4/4 [00:00&lt;00:00,    4.09it/s]
+ 25%|██▌       | Anonymizing : 1/4 [00:00&lt;00:01,    2.93it/s]
+ 50%|█████     | Anonymizing : 2/4 [00:01&lt;00:01,    1.81it/s]
+100%|██████████| Anonymizing : 4/4 [00:01&lt;00:00,    3.64it/s]
 |MNE-sample-data-bids-anon/
 |--- README
 |--- dataset_description.json
@@ -1000,7 +1000,7 @@ <h2>Reproducibility<a class="headerlink" href="#reproducibility" title="Permalin
 |------------ 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 10.825 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 11.716 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-anonymize-dataset-py">
 <div class="binder-badge docutils container">
 <a class="reference external image-reference" href="https://mybinder.org/v2/gh/mne-tools/mne-bids/gh-pages?filepath=dev/notebooks/auto_examples/anonymize_dataset.ipynb"><img alt="Launch binder" src="../_images/binder_badge_logo.svg" width="150px" /></a>
@@ -1091,7 +1091,7 @@ <h2>Reproducibility<a class="headerlink" href="#reproducibility" title="Permalin
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/auto_examples/bidspath.html

@@ -818,7 +818,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/auto_examples/convert_eeg_to_bids.html

@@ -1129,7 +1129,7 @@ <h2>Cite mne-bids<a class="headerlink" href="#cite-mne-bids" title="Permalink to
 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.605 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.620 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="binder-badge docutils container">
 <a class="reference external image-reference" href="https://mybinder.org/v2/gh/mne-tools/mne-bids/gh-pages?filepath=dev/notebooks/auto_examples/convert_eeg_to_bids.ipynb"><img alt="Launch binder" src="../_images/binder_badge_logo.svg" width="150px" /></a>
@@ -1218,7 +1218,7 @@ <h2>Cite mne-bids<a class="headerlink" href="#cite-mne-bids" title="Permalink to
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/auto_examples/convert_empty_room.html

@@ -871,7 +871,7 @@
 <Raw | sub-emptyroom_ses-20021204_task-noise_meg.fif, 315 x 66068 (110.0 s), ~354 kB, data not loaded>
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.800 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.125 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="binder-badge docutils container">
 <a class="reference external image-reference" href="https://mybinder.org/v2/gh/mne-tools/mne-bids/gh-pages?filepath=dev/notebooks/auto_examples/convert_empty_room.ipynb"><img alt="Launch binder" src="../_images/binder_badge_logo.svg" width="150px" /></a>
@@ -943,7 +943,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/auto_examples/convert_group_studies.html

@@ -953,7 +953,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.136 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.199 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="binder-badge docutils container">
 <a class="reference external image-reference" href="https://mybinder.org/v2/gh/mne-tools/mne-bids/gh-pages?filepath=dev/notebooks/auto_examples/convert_group_studies.ipynb"><img alt="Launch binder" src="../_images/binder_badge_logo.svg" width="150px" /></a>
@@ -1025,7 +1025,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>

dev/auto_examples/convert_ieeg_to_bids.html

@@ -1489,7 +1489,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 4.977 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 5.237 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="binder-badge docutils container">
 <a class="reference external image-reference" href="https://mybinder.org/v2/gh/mne-tools/mne-bids/gh-pages?filepath=dev/notebooks/auto_examples/convert_ieeg_to_bids.ipynb"><img alt="Launch binder" src="../_images/binder_badge_logo.svg" width="150px" /></a>
@@ -1581,7 +1581,7 @@ <h2>Step 5: Store coordinates in a template space<a class="headerlink" href="#st
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-26.
+      © Copyright 2017-2023, MNE Developers. Last updated on 2023-10-30.
       <br/>
 
   </p>