From e28b8539ba1961a033edeb75f28e5c7988cc4d7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Mon, 28 Oct 2024 20:58:13 -0400 Subject: [PATCH] DOC: Improve `plot_corrmat` function docstring Improve `plot_corrmat` function docstring: - Match the order of parameters in the function signature. - Document the `symmetric` and `figsize` parameters. --- mriqc_learn/viz/metrics.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/mriqc_learn/viz/metrics.py b/mriqc_learn/viz/metrics.py index f79debe..c2e8c14 100644 --- a/mriqc_learn/viz/metrics.py +++ b/mriqc_learn/viz/metrics.py @@ -193,10 +193,10 @@ 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. @@ -204,6 +204,11 @@ def plot_corrmat( 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`.