Skip to contents

Add reference lines to a plotly figure from Shiny inputs

Source: R/plot_reference_lines.R
add_reference_lines.Rd

Convenience wrapper that adds horizontal, vertical, and/or diagonal lines to a plotly figure based on parsed Shiny input values.

Usage

add_reference_lines(
  fig,
  hline.intercepts = NULL,
  hline.colors = NULL,
  hline.widths = NULL,
  hline.linetypes = NULL,
  hline.opacities = NULL,
  vline.intercepts = NULL,
  vline.colors = NULL,
  vline.widths = NULL,
  vline.linetypes = NULL,
  vline.opacities = NULL,
  abline.slopes = NULL,
  abline.intercepts = NULL,
  abline.colors = NULL,
  abline.widths = NULL,
  abline.linetypes = NULL,
  abline.opacities = NULL
)

Arguments

fig

A plotly figure object.

hline.intercepts

Character. Comma-separated y-intercepts for horizontal lines.

hline.colors

Character. Comma-separated colors for horizontal lines.

hline.widths

Character. Comma-separated widths for horizontal lines.

hline.linetypes

Character. Comma-separated linetypes for horizontal lines.

hline.opacities

Character. Comma-separated opacities for horizontal lines.

vline.intercepts

Character. Comma-separated x-intercepts for vertical lines.

vline.colors

Character. Comma-separated colors for vertical lines.

vline.widths

Character. Comma-separated widths for vertical lines.

vline.linetypes

Character. Comma-separated linetypes for vertical lines.

vline.opacities

Character. Comma-separated opacities for vertical lines.

abline.slopes

Character. Comma-separated slopes for diagonal lines.

abline.intercepts

Character. Comma-separated y-intercepts for diagonal lines.

abline.colors

Character. Comma-separated colors for diagonal lines.

abline.widths

Character. Comma-separated widths for diagonal lines.

abline.linetypes

Character. Comma-separated linetypes for diagonal lines.

abline.opacities

Character. Comma-separated opacities for diagonal lines.

Value

The modified plotly figure with all specified lines added.

Author

Jared Andrews

Examples

fig <- plotly::plot_ly(mtcars, x = ~wt, y = ~mpg, type = "scatter", mode = "markers")
add_reference_lines(fig,
    hline.intercepts = "20, 30", hline.colors = "red, blue",
    vline.intercepts = "3", abline.slopes = "5", abline.intercepts = "0"
)