show_tdlcrkline: Add a line or annotation to a plotly graph

View source: R/show_tdlcrkline.R

show_tdlcrklineR Documentation

Add a line or annotation to a plotly graph

Description

Add a line or annotation to a plotly graph for the tidal creek indicators

Usage

show_tdlcrkline(
  varin = c("CHLAC", "TN", "chla_tn_ratio", "DO", "tsi", "no23_ratio"),
  thrsel = FALSE,
  horiz = TRUE,
  annotate = FALSE
)

Arguments

varin

chr string for the indicator

thrsel

logical if something is returned, otherwise NULL, this is a hack for working with the plotly output

horiz

logical indicating if output is horizontal or vertical

annotate

logical indicating if output is line or annotation text

Details

This function is used internally within show_tdlcrkindic and show_tdlcrkindiccdf

Value

A list object passed to the layout argument of plotly, either shapes or annotate depending on user input

Examples

# code for vertical line output, chloropyll
show_tdlcrkline('CHLAC', thrsel = TRUE)

tbep-tech/tbeptools documentation built on April 13, 2025, 4:50 p.m.