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.plotting.plot_pca¶

brainprep.interfaces.plotting.plot_pca(pca_file, output_dir, dryrun=False)[source]¶

Plot the two first PCA components.

Parameters:

pca_fileFile: TSV file containing PCA two first components as two columns named pc1 and pc2, as well as BIDS participant_id, session, and run.
output_dirDirectory: Directory where the result image will be saved.
dryrunbool: If True, skip actual computation and file writing. Default False.

Returns:

pca_image_fileFile: Generated image with the two first PCA components.