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_network

brainprep.interfaces.plot_network(network_file, output_dir, entities, dryrun=False)

Plot the given network using nilearn.

The generated image will have the same name as the input network file.

Parameters:

network_fileFile

Path to a TSV file containing a square connectivity matrix. The first column and the first row are interpreted as labels and are used to annotate the plotted matrix.

output_dirDirectory

Directory where the image will be saved.

entitiesdict

A dictionary of parsed BIDS entities including modality.

dryrunbool

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

Returns:

network_image_fileFile

Path to the saved network image.