ENH: Add .bidsignore to outputs

Author: effigies

fmriprep/cli/run.py

@@ -12,7 +12,7 @@ def main():
     import gc
     from multiprocessing import Process, Manager
     from .parser import parse_args
-    from ..utils.bids import write_derivative_description
+    from ..utils.bids import write_derivative_description, write_bidsignore
 
     parse_args()
 
@@ -166,6 +166,7 @@ def main():
         write_derivative_description(
             config.execution.bids_dir, config.execution.output_dir / "fmriprep"
         )
+        write_bidsignore(config.execution.output_dir / "fmriprep")
 
         if failed_reports and not config.execution.notrack:
             sentry_sdk.capture_message(

fmriprep/utils/bids.py

@@ -7,6 +7,20 @@
 from pathlib import Path
 
 
+def write_bidsignore(deriv_dir):
+    bids_ignore = [
+        "*.html", "logs/", "figures/",  # Reports
+        "*_xfm.*",  # Unspecified transform files
+        "*.surf.gii",  # Unspecified structural outputs
+        # Unspecified functional outputs
+        "*_boldref.nii.gz", "*_bold.func.gii",
+        "*_mixing.tsv", "*_AROMAnoiseICs.csv", "*_regressors.tsv",
+        ]
+    ignore_file = Path(deriv_dir) / ".bidsignore"
+
+    ignore_file.write_text("\n".join(bids_ignore) + "\n")
+
+
 def write_derivative_description(bids_dir, deriv_dir):
     from ..__about__ import __version__, __url__, DOWNLOAD_URL