From 24bbdac54a9b2392e5f71652fe4cb7697f184976 Mon Sep 17 00:00:00 2001 From: Circle Ci Date: Mon, 5 Aug 2024 07:43:25 +0000 Subject: [PATCH] doc updates [skip ci] --- dev/.buildinfo | 2 +- .../auto_examples_python.zip | Bin 100203 -> 100203 bytes .../read_bids_datasets.zip | Bin 19850 -> 19850 bytes .../mark_bad_channels.zip | Bin 16499 -> 16499 bytes .../convert_mne_sample.zip | Bin 20493 -> 20493 bytes .../convert_nirs_to_bids.zip | Bin 16296 -> 16296 bytes .../convert_group_studies.zip | Bin 11192 -> 11192 bytes .../rename_brainvision_files.zip | Bin 8931 -> 8931 bytes .../auto_examples_jupyter.zip | Bin 154556 -> 154556 bytes .../bidspath.zip | Bin 17550 -> 17550 bytes .../convert_ieeg_to_bids.zip | Bin 47945 -> 47945 bytes .../update_bids_datasets.zip | Bin 11262 -> 11262 bytes .../create_bids_folder.zip | Bin 5694 -> 5694 bytes .../anonymize_dataset.zip | Bin 18580 -> 18580 bytes .../convert_eeg_to_bids.zip | Bin 21351 -> 21351 bytes .../convert_mri_and_trans.zip | Bin 27386 -> 27386 bytes .../convert_empty_room.zip | Bin 11994 -> 11994 bytes .../sphx_glr_convert_eeg_to_bids_001.png | Bin 40912 -> 40912 bytes .../sphx_glr_convert_ieeg_to_bids_001.png | Bin 84669 -> 84669 bytes .../sphx_glr_convert_mne_sample_001.png | Bin 174429 -> 174429 bytes .../sphx_glr_convert_mri_and_trans_001.png | Bin 201520 -> 201520 bytes .../sphx_glr_convert_mri_and_trans_002.png | Bin 85747 -> 85747 bytes .../sphx_glr_convert_mri_and_trans_003.png | Bin 94058 -> 94058 bytes .../sphx_glr_convert_mri_and_trans_004.png | Bin 94058 -> 94058 bytes .../sphx_glr_convert_nirs_to_bids_001.png | Bin 33388 -> 33388 bytes .../sphx_glr_mark_bad_channels_001.png | Bin 220481 -> 220481 bytes .../sphx_glr_mark_bad_channels_002.png | Bin 172843 -> 172843 bytes .../sphx_glr_read_bids_datasets_001.png | Bin 375349 -> 375349 bytes dev/_modules/index.html | 8 +-- dev/_modules/mne_bids/copyfiles.html | 8 +-- dev/_modules/mne_bids/dig.html | 8 +-- dev/_modules/mne_bids/inspect.html | 8 +-- dev/_modules/mne_bids/path.html | 61 +++++++++++++---- dev/_modules/mne_bids/read.html | 8 +-- dev/_modules/mne_bids/report/_report.html | 8 +-- dev/_modules/mne_bids/sidecar_updates.html | 8 +-- dev/_modules/mne_bids/stats.html | 8 +-- dev/_modules/mne_bids/utils.html | 8 +-- dev/_modules/mne_bids/write.html | 8 +-- dev/_static/documentation_options.js | 2 +- dev/api.html | 8 +-- dev/authors.html | 8 +-- dev/auto_examples/anonymize_dataset.html | 64 +++++++++--------- dev/auto_examples/bidspath.html | 8 +-- dev/auto_examples/convert_eeg_to_bids.html | 10 +-- dev/auto_examples/convert_empty_room.html | 10 +-- dev/auto_examples/convert_group_studies.html | 10 +-- dev/auto_examples/convert_ieeg_to_bids.html | 10 +-- dev/auto_examples/convert_mne_sample.html | 56 +++++++-------- dev/auto_examples/convert_mri_and_trans.html | 10 +-- dev/auto_examples/convert_nirs_to_bids.html | 10 +-- dev/auto_examples/create_bids_folder.html | 8 +-- dev/auto_examples/mark_bad_channels.html | 10 +-- dev/auto_examples/read_bids_datasets.html | 47 ++++++------- .../rename_brainvision_files.html | 8 +-- dev/auto_examples/sg_execution_times.html | 32 ++++----- dev/auto_examples/update_bids_datasets.html | 10 +-- dev/contribute.html | 8 +-- dev/generated/cli.html | 8 +-- dev/generated/mne_bids.BIDSPath.html | 15 ++-- dev/generated/mne_bids.anonymize_dataset.html | 8 +-- .../mne_bids.convert_montage_to_mri.html | 8 +-- .../mne_bids.convert_montage_to_ras.html | 8 +-- ...e_bids.copyfiles.copyfile_brainvision.html | 8 +-- .../mne_bids.copyfiles.copyfile_bti.html | 8 +-- .../mne_bids.copyfiles.copyfile_ctf.html | 8 +-- .../mne_bids.copyfiles.copyfile_edf.html | 8 +-- .../mne_bids.copyfiles.copyfile_eeglab.html | 8 +-- .../mne_bids.copyfiles.copyfile_kit.html | 8 +-- .../mne_bids.find_matching_paths.html | 15 ++-- .../mne_bids.get_anat_landmarks.html | 8 +-- .../mne_bids.get_anonymization_daysback.html | 8 +-- .../mne_bids.get_bids_path_from_fname.html | 8 +-- dev/generated/mne_bids.get_datatypes.html | 8 +-- .../mne_bids.get_entities_from_fname.html | 8 +-- dev/generated/mne_bids.get_entity_vals.html | 8 +-- .../mne_bids.get_head_mri_trans.html | 8 +-- dev/generated/mne_bids.inspect_dataset.html | 8 +-- .../mne_bids.make_dataset_description.html | 8 +-- dev/generated/mne_bids.make_report.html | 8 +-- dev/generated/mne_bids.mark_channels.html | 8 +-- dev/generated/mne_bids.print_dir_tree.html | 8 +-- dev/generated/mne_bids.read_raw_bids.html | 8 +-- .../mne_bids.search_folder_for_text.html | 8 +-- .../mne_bids.stats.count_events.html | 10 +-- dev/generated/mne_bids.template_to_head.html | 8 +-- .../mne_bids.update_anat_landmarks.html | 8 +-- .../mne_bids.update_sidecar_json.html | 8 +-- dev/generated/mne_bids.write_anat.html | 8 +-- .../mne_bids.write_meg_calibration.html | 8 +-- .../mne_bids.write_meg_crosstalk.html | 8 +-- dev/generated/mne_bids.write_raw_bids.html | 8 +-- dev/genindex.html | 8 +-- dev/index.html | 8 +-- dev/install.html | 8 +-- dev/objects.inv | Bin 3759 -> 3759 bytes dev/py-modindex.html | 8 +-- dev/search.html | 8 +-- dev/searchindex.js | 2 +- dev/sg_execution_times.html | 32 ++++----- dev/use.html | 8 +-- dev/whats_new.html | 11 +-- dev/whats_new_previous_releases.html | 8 +-- 103 files changed, 454 insertions(+), 407 deletions(-) diff --git a/dev/.buildinfo b/dev/.buildinfo index eb09dea40..86dd9f920 100644 --- a/dev/.buildinfo +++ b/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: afb9502624699115ff79eeba506855de +config: 4683779c88973204f281741250e6435d tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip index afb2e9016d74ed28c2239ed7d82e2346232b029d..af8a763d012880e11ecb5fd3a03cc827211d3a66 100644 GIT binary patch delta 298 zcmaFe$M(99jW58PnMH&F1OjYXBRBG$kY%w2GB)3m-J}g+P4MjIXE6bZ$w#KhvDkoE z?d8W6Sj<4Ipc#6S5OpmZo%mP`L1L%&3&^negIM=&JF`Prs*i0XSo}a@slN;PS$u%3 z?YFoXrw4+ix0l8+KIUf$1&PMwFouY;fLt?uOEaS#*zoD!ni-uSESnY}3*?;XO)ZS} zVCPIf+QR4ncFuIpR+tX&Rz_E_bEZ#e1*!u%XZm$GORA006zrVo!EHcUkaMO_Yh!eT QsJjhffgCekp`Fni0O*ia^#A|> delta 298 zcmaFe$M(99jW58PnMH&F1T@S3MQr3dAZ&%z55laEZ1V-W?h z+RKkCu<(OeK{NCuA?jK-I`Oe^g2Ybk7m#5A8Mpb~ZD)1}OZBmh1d9epEcJIGKZ_cW zwfzf0D`XJGm9L5lFu;}zH&5U+n!>501W^{tEY+8UUkaMOtwJ_R) zoiqJt3!?+rIny~?VLH598C}87nLeczs1D?u>DS>bsWwJauydvdw*h5A&Y3=~jnNUJ P?ly=8a?Esvc1CXiHUV=N diff --git a/dev/_downloads/268d987293d4ee80f1e0d3ca84cf1bd4/read_bids_datasets.zip b/dev/_downloads/268d987293d4ee80f1e0d3ca84cf1bd4/read_bids_datasets.zip index 9ad5edcdd1d92b3aea6d6959c0639a1fde542317..77c45c2c43a1fb3bcc9d456666f60dae28c9486d 100644 GIT binary patch delta 53 zcmeC0&Db@YkuSiTnMH&F1PpCiBRBF1$gr3I8Jm@4t{Sj_geL#?u?GuHw)6D?06j_! Aw*UYD delta 53 zcmeC0&Db@YkuSiTnMH&F1USq7MQr2~kYV8kGBzv8Ts2?;2~Ga(V-FUZZ0G9(0FUJm A-2eap diff --git a/dev/_downloads/2d16cae3d55264a4b7d58ed70766e580/mark_bad_channels.zip b/dev/_downloads/2d16cae3d55264a4b7d58ed70766e580/mark_bad_channels.zip index 1f07f6a68f09a9d8fec21bdcbc27c86f3f3af104..858536428e890dc2aca70a0570af912d30a3c4bd 100644 GIT binary patch delta 53 zcmey|!1%d=kuSiTnMH&F1k7w%BRBHtNwU}g8Jis>7pbv;geE_;w*w1J)^P9!0A1M) A9{>OV delta 53 zcmey|!1%d=kuSiTnMH&F1o+GTMQr5LlVlMEGB!I%E>dFw2~B=xZwD5dtl{7d0I;bM AM*si- diff --git a/dev/_downloads/4643fc773d02dab3aa626f7f7d767950/convert_mne_sample.zip b/dev/_downloads/4643fc773d02dab3aa626f7f7d767950/convert_mne_sample.zip index 1de05c22943feadfb9e2a6110bd541cd8115238d..c2e942e321602f4fd016f98f7dc2a623d42136d5 100644 GIT binary patch delta 53 zcmeBOz}UNhkuSiTnMH&F1WasMBRBG;$g!9K8Jo-GSPWS}LX+$K?ZHBm5BmE606t<2 AxBvhE delta 53 zcmeBOz}UNhkuSiTnMH&F1bEB-MQr3tkz?TpGB%gVu^6&|geKSd+k=HBAN2PD0Fg2f A-~a#s diff --git a/dev/_downloads/4c4fb656ad2ed5296dbabd0c14fa2b02/convert_nirs_to_bids.zip b/dev/_downloads/4c4fb656ad2ed5296dbabd0c14fa2b02/convert_nirs_to_bids.zip index 8e8a6c8e7b010bb345cc53939f2ed2f0149075fa..31e9021f1defd36589d6aaf85a4f9a048eaa0242 100644 GIT binary patch delta 51 ucmZ2czoMQmz?+#xgaHIXZCN8X@&$>rfEb%o#Mi2WS(8QW9U+V;dp`g~2MntK delta 51 ucmZ2czoMQmz?+#xgaHKf%l<`dpK0WmhGh_6)#vnGq$J3<&y_I?1DFA&!N diff --git a/dev/_downloads/5d54d38fa89e77a34bdfd9413b4fbe4f/convert_group_studies.zip b/dev/_downloads/5d54d38fa89e77a34bdfd9413b4fbe4f/convert_group_studies.zip index f8af155fb6ea39f2bc534ccb9b4044301882ae45..903a1c336cb87483f813957b637659fa9c771f62 100644 GIT binary patch delta 51 ucmdlHz9XD3z?+#xgaHI>ZCN8X@^$mGfEb(S@;6C?S(BBuogj=%ZGQkbR}4J> delta 51 ucmdlHz9XD3z?+#xgaHJ^%Kk-cZCN8X@;ULbfEb%Y_&x}OS(81KTp^5!NRSm<%Ce zNn5`gve}zHS_VvO)xpf^x5Jqn!ETza5W(aMwrhGOhy`-f z^i2^=P7tvl5lqftH%+&X1nK~}eR@kIlLy#I(=S8<)qz|zT`UU5iiu*ffQZciiGiFm Y{azH43)nT&)uMqckYlFjMKk#U02kU+Q2+n{ delta 303 zcmdn9opaB2PQCzdW)=|!5YR9C7qO8~U5iBx$k=SDHQSCw48*#T(ICyj4`Ri%Fd0I` zlD2*~WDy04#Xeu41{T}S$jA6jn1vT8xc##t<7ERDO%U@`5Mu}*gsGIsxL+H>eA>f! zNRCAVq+s=GM)pjI=r$3i0%;bIJGN^XFs)SwGpFAUXL1C)X}UrLlPlP+>6suF$W7BX zMKC!*#C}9DIfLCa-98ei1LXGUEs;zfU?)w#5D8QVa?y0LC>Sdyipc^ZHUlIEa?bR7 UQA{onF|}wQ3*?yTdC^RM0GFt7cK`qY diff --git a/dev/_downloads/701f5b32d08455f1c1e98b7ab1715881/bidspath.zip b/dev/_downloads/701f5b32d08455f1c1e98b7ab1715881/bidspath.zip index 6b498cc1a7ef9b5754b6ed5a5e1b915400efde16..3b51de7464034e808b303989a6605bc486433ea2 100644 GIT binary patch delta 53 wcmeC{WbEr?>!Sf8{TdW&sIJ&enDW3r*gj?FRsE%nm>R delta 51 vcmewt{x6&_z?+#xgaHIJ%l<`dKR#S@wBs7`b!wxJo+0(-t090%Z A0{{R3 delta 53 zcmbO-k#WjIM!o=VW)=|!5YR097qOA=ge;3bkg@retfm$VNN6&S;in-BNNDo4AP2C}WT{|Z0Fjmt A4*&oF delta 53 zcmaF9jPdz0M!o=VW)=|!5D+c<7qOA=xB`n9kg@ru!cRjMkkI67K@MP{$x^|-0OV#9 AHvj+t diff --git a/dev/_downloads/d90b2c92d1a1159e30b2143cd51843b4/convert_mri_and_trans.zip b/dev/_downloads/d90b2c92d1a1159e30b2143cd51843b4/convert_mri_and_trans.zip index 9c96fadb9ad27bc3693b7edd5af6de6b62cbf002..de3493f42c99e051047f6eb06007a4816f967777 100644 GIT binary patch delta 53 zcmex$mGReAM!o=VW)=|!5U{mnjoiq$Nt?w7$k=>Dd#)V|NN93umJ?WL^6D&q0Hb6N AqW}N^ delta 53 zcmex$mGReAM!o=VW)=|!5D+W-7qO9VlQxSQkg@rQ_FOv_kkI7REGMwgV!Z diff --git a/dev/_downloads/f6baa7da9ece655f45f704c75843a8ff/convert_empty_room.zip b/dev/_downloads/f6baa7da9ece655f45f704c75843a8ff/convert_empty_room.zip index 1b6556dc48618c50958d836cbae8b6d39bc71881..238e71893dc8c066b26d356676a6cd838e2c7c46 100644 GIT binary patch delta 51 ycmcZ=dn=YNz?+#xgaHKnY*`~W@)h#4_yZZ6oB5B(v4Dgod+XVQg(mmu`2YY=R1Glz delta 51 ycmcZ=dn=YNz?+#xgaHIJ%Kk-cG~!t9@{piWz7cwZxaxc delta 43 zcmcbxpXtJWrU@Q$hB^uvB_##LR{Hw6i6sR&`6W4-NqYH3>H3!?-zjcP%bE`Wb-NK+ diff --git a/dev/_images/sphx_glr_convert_ieeg_to_bids_001.png b/dev/_images/sphx_glr_convert_ieeg_to_bids_001.png index 0d702fff1ca52c216e4267dc8392ca620b80194a..b135dd77d045f732c1d58e723bcef7983f15b804 100644 GIT binary patch delta 46 zcmdlxm38k_)(IYR2098EB_##LR{Hw6i6sR&`6W4-NqYH3>G~!t9@`qzwx%(LdjSBA CC=jCn delta 46 zcmdlxm38k_)(IYRhB^uvB_##LR{Hw6i6sR&`6W4-NqYH3>H3!?-zhexZB1hg_W}Tx CA`xi- diff --git a/dev/_images/sphx_glr_convert_mne_sample_001.png b/dev/_images/sphx_glr_convert_mne_sample_001.png index 37716bda437ae9b0470ccc39f2f851e115158da5..cbdca94f72dc7e59a14f5981ce1b63e1714e9378 100644 GIT binary patch delta 49 zcmcb6iRG~!t9@`qzTGJS}rZIhA F0RZMh6H)*G delta 49 zcmcb6iRH3!?-zhexwWcv{O=J4L F0s!%k6c_*i diff --git a/dev/_images/sphx_glr_convert_mri_and_trans_001.png b/dev/_images/sphx_glr_convert_mri_and_trans_001.png index 6bdb800abaa576dd6b43a313836517921f574f7f..b9065a68b42cc757771f86baf01a31764bc0b167 100644 GIT binary patch delta 52 zcmdn6jAz3#o(Udu2098EB_##LR{Hw6i6sR&`6W4-NqYH3>G~!t9@`qzTGJR?)0noV IF`p6w0Q?gY&j0`b delta 52 zcmdn6jAz3#o(UduhB^uvB_##LR{Hw6i6sR&`6W4-NqYH3>H3!?-zhexwWcw)rZH_z IV?HGW013bol>h($ diff --git a/dev/_images/sphx_glr_convert_mri_and_trans_002.png b/dev/_images/sphx_glr_convert_mri_and_trans_002.png index 6421a1f46afe68ecf855498d09b6d4429e1a4c4a..8c89e37bcc2ab210a77c5e6eff4df1c02db4bbe4 100644 GIT binary patch delta 46 zcmex7m-X{p)(IYR2098EB_##LR{Hw6i6sR&`6W4-NqYH3>G~!t9@`qzwx%)m`T+o= C77H3!?-zhexZB1kB^#cH` C5E35% diff --git a/dev/_images/sphx_glr_convert_mri_and_trans_003.png b/dev/_images/sphx_glr_convert_mri_and_trans_003.png index fb3667c65169e1633fef0ae68d70833eec49b9a5..182b60ff318fa00ebdd3b1c5826791629884748c 100644 GIT binary patch delta 46 zcmaELkM-3()(IYR2098EB_##LR{Hw6i6sR&`6W4-NqYH3>G~!t9@`qzwx%(%H3!?-zhexZB1ij$p-+w C6%r=^ diff --git a/dev/_images/sphx_glr_convert_mri_and_trans_004.png b/dev/_images/sphx_glr_convert_mri_and_trans_004.png index fb3667c65169e1633fef0ae68d70833eec49b9a5..182b60ff318fa00ebdd3b1c5826791629884748c 100644 GIT binary patch delta 46 zcmaELkM-3()(IYR2098EB_##LR{Hw6i6sR&`6W4-NqYH3>G~!t9@`qzwx%(%H3!?-zhexZB1ij$p-+w C6%r=^ diff --git a/dev/_images/sphx_glr_convert_nirs_to_bids_001.png b/dev/_images/sphx_glr_convert_nirs_to_bids_001.png index bbf41efce18dca9f8fa603467367ea9403f5e9db..e4265fe659ec6be62c4dc029d6935aac3ed79819 100644 GIT binary patch delta 43 ycmaFU!t|zvX@ZBGfsR5(Nl8JmmA-y%Vo5G~!t9@`qzTGJR?)0noV IG2e~>01IFfb^rhX delta 52 zcmX@Oi}&Cz-U%LZhB^uvB_##LR{Hw6i6sR&`6W4-NqYH3>H3!?-zhexwWcw)rZH_z IW4;{&02uxhJOBUy diff --git a/dev/_images/sphx_glr_mark_bad_channels_002.png b/dev/_images/sphx_glr_mark_bad_channels_002.png index dac7deed0160981f682748d1b6bfae2340f18e1b..814e073ec4bef8ccc51980f4502a3f4cc250ae81 100644 GIT binary patch delta 49 zcmZ2|jBE8Vt_dD;2098EB_##LR{Hw6i6sR&`6W4-NqYH3>G~!t9@`qzTGJS}rZF8| F1OU$O5}p76 delta 49 zcmZ2|jBE8Vt_dD;hB^uvB_##LR{Hw6i6sR&`6W4-NqYH3>H3!?-zhexwWcv{O=CK` F2msnU6J!7Y diff --git a/dev/_images/sphx_glr_read_bids_datasets_001.png b/dev/_images/sphx_glr_read_bids_datasets_001.png index eee0de2feac5d625b44a32f2670d8370fd4d99ba..59f3b4f3d906d3c28499864eeb91f95d5c5f17fc 100644 GIT binary patch delta 58 zcmdn`MQrOAu?Ze>2098EB_##LR{Hw6i6sR&`6W4-NqYH3>G~!t9@`qzTGJR?)0kS* Om|N3Wwx+S3-w6Pk_!blZ delta 58 zcmdn`MQrOAu?Ze>hB^uvB_##LR{Hw6i6sR&`6W4-NqYH3>H3!?-zhexwWcw)rZKgq OF}J3%Y)xZ5zY_qhIu_ah diff --git a/dev/_modules/index.html b/dev/_modules/index.html index ace62cdaa..a2237267f 100644 --- a/dev/_modules/index.html +++ b/dev/_modules/index.html @@ -7,7 +7,7 @@ - Overview: module code — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation + Overview: module code — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation @@ -40,7 +40,7 @@ - + @@ -147,7 +147,7 @@ -

MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+

MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

@@ -564,7 +564,7 @@

All modules for which code is available

- © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30. + © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.

diff --git a/dev/_modules/mne_bids/copyfiles.html b/dev/_modules/mne_bids/copyfiles.html index 01e9b7cc1..22965d55b 100644 --- a/dev/_modules/mne_bids/copyfiles.html +++ b/dev/_modules/mne_bids/copyfiles.html @@ -7,7 +7,7 @@ - mne_bids.copyfiles — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation + mne_bids.copyfiles — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation @@ -40,7 +40,7 @@ - + @@ -147,7 +147,7 @@ -

MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+

MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

@@ -1211,7 +1211,7 @@

Source code for mne_bids.copyfiles

 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/dig.html b/dev/_modules/mne_bids/dig.html
index a11e225dd..8c3e83191 100644
--- a/dev/_modules/mne_bids/dig.html
+++ b/dev/_modules/mne_bids/dig.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.dig — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.dig — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
@@ -1357,7 +1357,7 @@

Source code for mne_bids.dig

 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/inspect.html b/dev/_modules/mne_bids/inspect.html
index f5052237c..e866051f0 100644
--- a/dev/_modules/mne_bids/inspect.html
+++ b/dev/_modules/mne_bids/inspect.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.inspect — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.inspect — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
@@ -1012,7 +1012,7 @@

Source code for mne_bids.inspect

 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/path.html b/dev/_modules/mne_bids/path.html
index 7646dd344..f78df8c5c 100644
--- a/dev/_modules/mne_bids/path.html
+++ b/dev/_modules/mne_bids/path.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.path — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.path — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
@@ -1223,7 +1223,9 @@

Source code for mne_bids.path

             raise RuntimeError("The root must not be None to remove files.")
 
         # Planning:
-        paths_matched = self.match(ignore_json=False, check=self.check)
+        paths_matched = self.match(
+            ignore_json=False, ignore_nosub=False, check=self.check
+        )
         subjects = set()
         paths_to_delete = list()
         paths_to_update = {}
@@ -1539,7 +1541,7 @@ 
Source code for mne_bids.path
 
 

 [docs]
-    def match(self, ignore_json=True, check=False):
+    def match(self, *, ignore_json=True, ignore_nosub=False, check=False):
         """Get a list of all matching paths in the root directory.
 
         Performs a recursive search, starting in ``.root`` (if set), based on
@@ -1549,6 +1551,9 @@ 
Source code for mne_bids.path
         ----------
         ignore_json : bool
             If ``True``, ignores json files. Defaults to ``True``.
+        ignore_nosub : bool
+            If ``True``, ignores all files that are not of the form ``root/sub-*``.
+            Defaults to ``False``.
         check : bool
             If ``True``, only returns paths that conform to BIDS. If ``False``
             (default), the ``.check`` attribute of the returned
@@ -1569,7 +1574,10 @@ 
Source code for mne_bids.path
             )
 
         paths = _return_root_paths(
-            self.root, datatype=self.datatype, ignore_json=ignore_json
+            self.root,
+            datatype=self.datatype,
+            ignore_json=ignore_json,
+            ignore_nosub=ignore_nosub,
         )
 
         fnames = _filter_fnames(
@@ -2890,6 +2898,9 @@ 
Source code for mne_bids.path
     extensions=None,
     datatypes=None,
     check=False,
+    *,
+    ignore_json=False,
+    ignore_nosub=False,
 ):
     """Get list of all matching paths for all matching entity values.
 
@@ -2949,6 +2960,11 @@ 
Source code for mne_bids.path
         (default), the ``.check`` attribute of the returned
         :class:`mne_bids.BIDSPath` object will be set to ``True`` for paths that
         do conform to BIDS, and to ``False`` for those that don't.
+    ignore_json : bool
+        If ``True``, ignores json files. Defaults to ``False``.
+    ignore_nosub : bool
+        If ``True``, ignores all files that are not of the form ``root/sub-*``.
+        Defaults to ``False``.
 
     Returns
     -------
@@ -2956,7 +2972,9 @@ 
Source code for mne_bids.path
         The matching paths.
 
     """
-    fpaths = _return_root_paths(root, datatype=datatypes, ignore_json=False)
+    fpaths = _return_root_paths(
+        root, datatype=datatypes, ignore_json=ignore_json, ignore_nosub=ignore_nosub
+    )
 
     fpaths_filtered = _filter_fnames(
         fpaths,
@@ -2979,16 +2997,29 @@ 
Source code for mne_bids.path
 
 
 
-def _return_root_paths(root, datatype=None, ignore_json=True):
-    """Return all paths in root.
+def _return_root_paths(root, datatype=None, ignore_json=True, ignore_nosub=False):
+    """Return all file paths in root.
 
     Can be filtered by datatype (which is present in the path but not in
     the BIDSPath basename). Can also be list of datatypes.
+
+    Parameters
+    ----------
     root : pathlib.Path | str
         The root of the BIDS path.
     datatype : str | array-like of str | None
         The BIDS data type, e.g., ``'anat'``, ``'func'``, ``'eeg'``, ``'meg'``,
         ``'ieeg'``.
+    ignore_json : bool
+        If ``True`` (default), do not return files ending with ``.json``.
+    ignore_nosub : bool
+        If ``True``, return only files of the form ``root/sub-*``. Defaults to
+        ``False``.
+
+    Returns
+    -------
+    paths : list of pathlib.Path
+        All paths in `root`, filtered according to the function parameters.
     """
     root = Path(root)  # if root is str
 
@@ -2999,13 +3030,19 @@ 
Source code for mne_bids.path
         search_str = "*.*"
 
     paths = root.rglob(search_str)
-    # Only keep files (not directories), and omit the JSON sidecars
-    # if ignore_json is True.
+    # Only keep files (not directories), ...
+    # and omit the JSON sidecars if `ignore_json` is True.
     if ignore_json:
         paths = [p for p in paths if p.is_file() and p.suffix != ".json"]
     else:
         paths = [p for p in paths if p.is_file()]
 
+    # only keep files which are of the form root/sub-*,
+    # such that we only look in 'sub'-folders:
+    if ignore_nosub:
+        root_sub = str(root / "sub-")
+        paths = [p for p in paths if str(p).startswith(root_sub)]
+
     return paths
 
 
@@ -3094,7 +3131,7 @@ 
Source code for mne_bids.path
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/read.html b/dev/_modules/mne_bids/read.html
index a6369d394..e3c483fe4 100644
--- a/dev/_modules/mne_bids/read.html
+++ b/dev/_modules/mne_bids/read.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.read — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.read — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -1744,7 +1744,7 @@ 
Source code for mne_bids.read
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/report/_report.html b/dev/_modules/mne_bids/report/_report.html
index bd4a64d58..2a1e8c3c4 100644
--- a/dev/_modules/mne_bids/report/_report.html
+++ b/dev/_modules/mne_bids/report/_report.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.report._report — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.report._report — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -1098,7 +1098,7 @@ 
Source code for mne_bids.report._report
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/sidecar_updates.html b/dev/_modules/mne_bids/sidecar_updates.html
index 55b25da94..0b9feb27c 100644
--- a/dev/_modules/mne_bids/sidecar_updates.html
+++ b/dev/_modules/mne_bids/sidecar_updates.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.sidecar_updates — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.sidecar_updates — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -949,7 +949,7 @@ 
Source code for mne_bids.sidecar_updates
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/stats.html b/dev/_modules/mne_bids/stats.html
index e66e77a0d..3d4265cb7 100644
--- a/dev/_modules/mne_bids/stats.html
+++ b/dev/_modules/mne_bids/stats.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.stats — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.stats — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -689,7 +689,7 @@ 
Source code for mne_bids.stats
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/utils.html b/dev/_modules/mne_bids/utils.html
index 2dd0417ce..02f22bd47 100644
--- a/dev/_modules/mne_bids/utils.html
+++ b/dev/_modules/mne_bids/utils.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.utils — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.utils — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -1097,7 +1097,7 @@ 
Source code for mne_bids.utils
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_modules/mne_bids/write.html b/dev/_modules/mne_bids/write.html
index 17ab3d0a3..17818575a 100644
--- a/dev/_modules/mne_bids/write.html
+++ b/dev/_modules/mne_bids/write.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.write — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    mne_bids.write — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -3725,7 +3725,7 @@ 
Source code for mne_bids.write
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js
index 73bf67477..f4bdaf439 100644
--- a/dev/_static/documentation_options.js
+++ b/dev/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.16.0.dev20+g3cbdbab8',
+    VERSION: '0.16.0.dev21+ge37d3b51',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/dev/api.html b/dev/api.html
index 1d486cb1c..44ccdd1c6 100644
--- a/dev/api.html
+++ b/dev/api.html
@@ -8,7 +8,7 @@
     
     
 
-    API Documentation — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    API Documentation — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -150,7 +150,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -779,7 +779,7 @@ 
mne_bids.copyfiles
     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/authors.html b/dev/authors.html
index 3af5c66ff..f62c4e27d 100644
--- a/dev/authors.html
+++ b/dev/authors.html
@@ -8,7 +8,7 @@
     
     
 
-    <no title> — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    <no title> — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -148,7 +148,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -575,7 +575,7 @@
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-30.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-08-05.
       

     
   

diff --git a/dev/auto_examples/anonymize_dataset.html b/dev/auto_examples/anonymize_dataset.html
index 12c39adab..5a425f3b7 100644
--- a/dev/auto_examples/anonymize_dataset.html
+++ b/dev/auto_examples/anonymize_dataset.html
@@ -8,7 +8,7 @@
     
     
 
-    13. Anonymizing a BIDS dataset — MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation
+    13. Anonymizing a BIDS dataset — MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -151,7 +151,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev20+g3cbdbab8 documentation

+    
MNE-BIDS 0.16.0.dev21+ge37d3b51 documentation

   
 

     
@@ -675,7 +675,7 @@ 
Basic anonymizationSpecifying subject IDsSpecifying subject IDsSpecifying subject IDs

 

 
@@ -930,9 +930,9 @@ 
ReproducibilityTotal running time of the script: (0 minutes 11.307 seconds)

+
Total running time of the script: (0 minutes 11.182 seconds)

 
     
@@ -1127,7 +1127,7 @@ 
Cite mne-bidshttps://bids-standard.github.io/bids-validator/

 
Command line tool: https://www.npmjs.com/package/bids-validator

-
Total running time of the script: (0 minutes 0.354 seconds)

+
Total running time of the script: (0 minutes 0.352 seconds)

 

 

-
Total running time of the script: (0 minutes 2.069 seconds)

+
Total running time of the script: (0 minutes 1.899 seconds)

 

 

-
Total running time of the script: (0 minutes 1.302 seconds)

+
Total running time of the script: (0 minutes 1.266 seconds)

This should be very similar to the ds000248 dataset_description.json!

-

Total running time of the script: (0 minutes 3.800 seconds)

+

Total running time of the script: (0 minutes 3.653 seconds)

-

Total running time of the script: (0 minutes 13.008 seconds)

+

Total running time of the script: (0 minutes 12.878 seconds)