​
Logs and Metadata

The logs/ and metadata/ folders are companion outputs that provide run-level transparency and support reproducibility.

​
Logs

logs/
└── autoclean_2025-09-04_10-19-42_527769.log
  • Plain-text log file of the pipeline execution.
  • Contains system messages, warnings, and step-by-step notes from the run.
  • Useful for debugging (e.g., if a step fails or behaves unexpectedly).
  • Each run generates a new log with a timestamped filename.
View Example Log File

​
Metadata

metadata/
├── 128_Rest_EyesOpen_D1004_autoclean_metadata.json
├── 128_Rest_EyesOpen_D1004_autoclean_report.pdf
└── ica_control_sheet.csv   (under construction)
  • *_autoclean_metadata.json Machine-readable JSON summary. Captures:
    • Run ID, timestamps, and task name.
    • User/system context (username, host, PID).
    • Directories used (bids/, derivatives/, final_files/).
    • Entry point and preprocessing parameters.
    • Status (completed, failed, etc.).
    View Example Metadata JSON
  • *_autoclean_report.pdf Human-readable QC report. Includes:
    • Import details (channels, duration, sample rate).
    • Processing details (filters, reference, resampling).
    • Full parameter table for reproducibility.
    View Example QC Report PDF
  • ica_control_sheet.csv (Under Construction) A new feature in development.
    • Will track ICA components across subjects.
    • Intended for manual review and component curation.
    • Planned integration: the ability to reapply ICA weights and resume downstream steps.

​
Example Content

​
Pipeline Execution Log

The log file captures the complete pipeline execution trace: View Complete Pipeline Log Key pipeline steps documented include: 
2025-09-04 10:19:42 | HEADER   | Starting processing for task: RestingStateTutorial
2025-09-04 10:19:44 | SUCCESS  | Successfully loaded .raw file with all events
2025-09-04 10:21:13 | HEADER   | Resampling data from 1000.0 Hz to 250 Hz...
2025-09-04 10:21:14 | HEADER   | Filtering data...
2025-09-04 10:21:25 | INFO     | Detected 9 bad channels: ['E3', 'E122', 'E107', 'E8', 'E14', 'E56', 'E17', 'E127', 'E2']
2025-09-04 10:21:40 | SUCCESS  | ICA step complete
2025-09-04 10:22:30 | INFO     | Applied ICA, removing components: [0, 1, 2, 4, 7, 8, 12, 13, 17, 18, 20, 28, 30, 31, 32, 35, 38, 45, 50, 64, 70, 98, 115]
2025-09-04 10:22:39 | SUCCESS  | ✓ Task RestingStateTutorial completed successfully

​
Processing Log Summary

The CSV processing log provides a comprehensive record of each run: View Complete Processing Log Key metrics captured include:
  • Channel Information: Original (128) vs. post-processing channel counts
  • Bad Channels: ['E56', 'E128', 'E8', 'E14', 'E17', 'E2']
  • Filtering: 1-80 Hz bandpass with 60/120 Hz notch filters
  • Epoching: 29 trials total, 7 rejected (75.8% retained)
  • ICA Components: 16 components removed from 121 total

​
Why These Matter

  • Logs capture the execution trace.
  • Metadata provides both a human-readable report and a machine-readable JSON.
  • Together, they ensure that every run is auditable, reproducible, and shareable.
  • The ICA control sheet will expand this functionality by enabling semi-automatic component review pipelines.