simplevis (version 1.5.0)

ggplot_scatter: Scatter ggplot.

Description

Scatter ggplot that is not coloured and not facetted.

Usage

ggplot_scatter(data, x_var, y_var, hover_var = NULL, size = 1,
  pal = NULL, x_scale_zero = TRUE, x_scale_zero_line = TRUE,
  x_scale_trans = "identity", x_scale_labels = waiver(),
  y_scale_zero = TRUE, y_scale_zero_line = TRUE,
  y_scale_trans = "identity", y_scale_labels = waiver(),
  title = "[Title]", subtitle = NULL, x_title = "[X title]",
  y_title = "[Y title]", caption = NULL, font_family = "Helvetica",
  font_size_title = NULL, font_size_body = NULL, wrap_title = 70,
  wrap_subtitle = 80, wrap_x_title = 50, wrap_y_title = 50,
  wrap_caption = 80, isMobile = FALSE)

Arguments

data

An ungrouped summarised tibble or dataframe. Required input.

x_var

Unquoted numeric variable to be on the x axis. Required input.

y_var

Unquoted numeric variable to be on the y axis. Required input.

hover_var

Unquoted variable to be an additional hover variable for when used inside plotly::ggplotly(). Defaults to NULL.

size

Size of points. Defaults to 1.

pal

Character vector of hex codes. Defaults to NULL, which selects the Stats NZ palette.

x_scale_zero

TRUE or FALSE whether the minimum of the x scale is zero. Defaults to TRUE.

x_scale_zero_line

TRUE or FALSE whether to add a zero line in for when values are above and below zero. Defaults to TRUE.

x_scale_trans

A string specifying a transformation for the x scale. Defaults to "identity".

x_scale_labels

Argument to adjust the format of the x scale labels.

y_scale_zero

TRUE or FALSE whether the minimum of the y scale is zero. Defaults to TRUE.

y_scale_zero_line

TRUE or FALSE whether to add a zero line in for when values are above and below zero. Defaults to TRUE.

y_scale_trans

A string specifying a transformation for the y scale. Defaults to "identity".

y_scale_labels

Argument to adjust the format of the y scale labels.

title

Title string. Defaults to "[Title]".

subtitle

Subtitle string. Defaults to "[Subtitle]".

x_title

X axis title string. Defaults to "[X title]".

y_title

Y axis title string. Defaults to "[Y title]".

caption

Caption title string. Defaults to NULL.

font_family

Font family to use. Defaults to "Helvetica".

font_size_title

Font size for the title text. Defaults to 11.

font_size_body

Font size for all text other than the title. Defaults to 10.

wrap_title

Number of characters to wrap the title to. Defaults to 70. Not applicable where isMobile equals TRUE.

wrap_subtitle

Number of characters to wrap the subtitle to. Defaults to 80. Not applicable where isMobile equals TRUE.

wrap_x_title

Number of characters to wrap the x title to. Defaults to 50. Not applicable where isMobile equals TRUE.

wrap_y_title

Number of characters to wrap the y title to. Defaults to 50. Not applicable where isMobile equals TRUE.

wrap_caption

Number of characters to wrap the caption to. Defaults to 80. Not applicable where isMobile equals TRUE.

isMobile

Whether the plot is to be displayed on a mobile device. Defaults to FALSE. In a shinyapp, isMobile should be specified as input$isMobile.

Value

A ggplot object.

Examples

# NOT RUN {
plot_data <- dplyr::sample_frac(ggplot2::diamonds, 0.05)

plot <- ggplot_scatter(data = plot_data, x_var = carat, y_var = price,
   title = "Diamond price by carat",
   x_title = "Carat",
   y_title = "Price ($US thousands)")

plot

plotly::ggplotly(plot, tooltip = "text")
# }