Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Improve plot_corrmat function docstring #26

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: Improve plot_corrmat function docstring #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions mriqc_learn/viz/metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,17 +193,22 @@ def plot_corrmat(
----------
data
A 2D numpy array of shape (M, N).
row_labels
A list or array of length M with the labels for the rows.
col_labels
A list or array of length N with the labels for the columns.
row_labels
A list or array of length M with the labels for the rows.
ax
A `matplotlib.axes.Axes` instance to which the heatmap is plotted. If
not provided, use current axes or create a new one. Optional.
cbar_kw
A dictionary with arguments to `matplotlib.Figure.colorbar`. Optional.
cbarlabel
The label for the colorbar. Optional.
symmetric
Use ``True`` if the matrix is symmetric to plot only the lower
triangular part of the matrix.
figsize
Figure size (width, height) in inches.
**kwargs
All other arguments are forwarded to `imshow`.

Expand Down