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.interfaces.plot_histogram

brainprep.interfaces.plot_histogram(table_file, col_name, output_dir, bar_coords=None, dryrun=False)

Generates a histogram image with optional vertical bars.

Parameters:

table_fileFile

TSV table containing the data to be displayed.

col_namestr

Name of the column containing the histogram data.

output_dirDirectory

Directory where the image with the histogram will be saved.

bar_coords: list[float] | None

Coordianates of vertical lines to be displayed in red. Default None.

dryrunbool

If True, skip actual computation and file writing. Default False.

Returns:

histogram_fileFile

Generated image with the histogram.