Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

brainprep.workflow.reporting.brainprep_group_reporting

brainprep.workflow.reporting.brainprep_group_reporting(output_dir, keep_intermediate=False)[source]

Pre-processings reporting.

This function generates a quality control (QC) report for the BrainPrep workflows. It includes the following steps:

  1. Generate a configuration file the following workflows: quality assurance, defacing, quasi-raw.

  2. Create a single HTML file regrouping the QC results.

Parameters:
output_dirDirectory

Directory where the outputs will be saved (i.e., the root of your dataset).

keep_intermediatebool

If True, retains intermediate results (i.e., the workspace); useful for debugging. Default False.

Returns:
Bunch

A dictionary-like object containing:

  • html_fileFile

    Path to the generated HTML report.

References

Examples

>>> from brainprep.config import Config
>>> from brainprep.workflow import brainprep_group_reporting
>>>
>>> with Config(dryrun=True, verbose=False):
...     outputs = brainprep_group_reporting(
...         output_dir="/tmp/dataset/derivatives",
...     )
>>> outputs
Bunch(
    html_file: PosixPath('...')
)