View source: R/adcp_plot_current_rose.R
adcp_plot_current_rose | R Documentation |
Generate current rose
adcp_plot_current_rose(
dat,
breaks,
speed_column,
direction_column,
speed_colors = NULL,
speed_label = "Current Speed (cm/s)",
add_dir_labs = TRUE
)
dat |
Data frame with column names that include the strings
|
breaks |
Number of break points for current speed OR a vector of breaks. Lower-inclusive. |
speed_column |
Column name of the current speed (or wave height) column (i.e., the length of the petals). |
direction_column |
Column name of the current (or wave ) direction column (i.e., the direction of the petals). |
speed_colors |
Vector of colours. Must be the same length as
|
speed_label |
Title of the current speed legend. Default is "Current Speed (cm/s)". |
add_dir_labs |
placeholder |
Generates a current rose using the windRose()
function from
the openair
package. See help files for openair::windRose
for
more detail.
For wave roses, replace "current speed" with "wave height".
Returns an "openair" object, a rose plot of current speed and direction.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.