From def9a4e57739663b18cd92375d401e50855efb66 Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Wed, 20 May 2020 21:34:10 -0700 Subject: [PATCH 1/2] Update pycmap_correlation_matrix_cruise_track.rst Megan's edits and comments --- .../pycmap_correlation_matrix_cruise_track.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst index 39e88ed..c8bbc1d 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst @@ -25,14 +25,14 @@ Correlation Matrix Along Cruise Track .. method:: plot_cruise_corr_map(cruise, targetTables, targetVars, depth1, depth2, temporalTolerance, latTolerance, lonTolerance, depthTolerance, method='spearman', exportDataFlag=False, show=True) - This function colocalizes the target variables along track of a cruise + This function colocalizes the target variables along the track of a cruise (see `Match (colocalize) Cruise Track with Datasets`_). It then computes and visualizes a correlation matrix showing the pairwise correlation coefficients between the colocalized variables. The colocalization procedure relies on the tolerance parameters because they set the matching boundaries between the cruise track and target datasets. Currently, this graph is only supported by plotly library. - Returns the generated correlation graph object. One may modify the graph properties (see example below). + This function returns the generated correlation graph object. One may modify the graph properties (see example below). .. note:: @@ -75,6 +75,7 @@ Correlation Matrix Along Cruise Track **exportDataFlag: boolean, default: False** If True, the graph data points are stored on the local machine. The export path and file format are set by the `APIs parameters`_. +..COMMENT: I think you want the above hyperlink to go to the API methods page instead. **show: boolean, default: True** If True, the graph object is returned and is displayed. The graph file is saved on the local machine at the figureDir directory. @@ -95,6 +96,7 @@ Correlation Matrix Along Cruise Track Computed pairwise correlation coefficients. **cmap: str or cmocean colormap** Colormap name. Any matplotlib (e.g. 'viridis', ..) or cmocean (e.g. cmocean.cm.thermal, ..) colormaps can be passed to this property. A full list of matplotlib and cmocean color palettes can be found at the following links: + https://matplotlib.org/3.1.0/tutorials/colors/colormaps.html https://matplotlib.org/cmocean/ @@ -122,15 +124,12 @@ Example This example colocalizes the Gradient 2 cruise (MGL1704) with 12 variables, including underway measurements of prochlorococcus, -synechococcus, and picoeukaryote abundances by `SeaFlow dataset`_, +synechococcus, and picoeukaryote abundances by the `SeaFlow dataset`_, satellite products (adt, chl, sst), and model estimates (see the ``match_params()`` function below for more details). Please explore the `catalog`_ to find more appropriate target variables. -Returns the generated correlation graph object. One may -modify the graph properties (see example below). - Review `Match (colocalize) Cruise Track with Datasets`_, and `Match (colocalize) Datasets`_ pages for more details and tips! From 5cc1a0201a2bd1ab45b49ebe43d8ea829c8f07af Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Wed, 27 May 2020 22:09:09 -0700 Subject: [PATCH 2/2] Update pycmap_correlation_matrix_cruise_track.rst --- .../pycmap_correlation_matrix_cruise_track.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst index c8bbc1d..26a342f 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst @@ -74,9 +74,6 @@ Correlation Matrix Along Cruise Track **exportDataFlag: boolean, default: False** If True, the graph data points are stored on the local machine. The export path and file format are set by the `APIs parameters`_. - -..COMMENT: I think you want the above hyperlink to go to the API methods page instead. - **show: boolean, default: True** If True, the graph object is returned and is displayed. The graph file is saved on the local machine at the figureDir directory. If False, the graph object is returned but not displayed.