adcp_plot_current_rose: Generate current rose

In dempsey-CMAR/adcp: Format and Visualize ADCP data

Generate current rose

Description

Generate current rose

Usage

adcp_plot_current_rose(
  dat,
  breaks,
  speed_column,
  direction_column,
  speed_colors = NULL,
  speed_label = "Current Speed (cm/s)",
  add_dir_labs = TRUE
)

Arguments

dat	Data frame with column names that include the strings "speed" and "direction".
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 breaks.
speed_label	Title of the current speed legend. Default is "Current Speed (cm/s)".
add_dir_labs	placeholder

Details

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".

Value

Returns an "openair" object, a rose plot of current speed and direction.

dempsey-CMAR/adcp documentation built on April 17, 2025, 4:30 a.m.