Skip to content

Update pycmap_correlation_matrix_cruise_track.rst #74

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

Open
MSchatzUW wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update pycmap_correlation_matrix_cruise_track.rst #74

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
def9a4e
Update pycmap_correlation_matrix_cruise_track.rst
MSchatzUW May 21, 2020
5cc1a02
Update pycmap_correlation_matrix_cruise_track.rst
MSchatzUW May 28, 2020
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
12 changes: 4 additions & 8 deletions ...PI_ref/pycmap_api/data_vizualization/pycmap_correlation_matrix_cruise_track.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -74,8 +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`_.


**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.
Expand All @@ -95,6 +93,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/
Expand Down Expand Up @@ -122,15 +121,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!

Expand Down