Learn R Programming

simplevis (version 3.1.0)

ggplot_point_col: Point ggplot that is coloured.

Description

Point ggplot that is coloured, but not facetted.

Usage

ggplot_point_col(data, x_var, y_var, col_var, text_var = NULL,
  size_point = 1, pal = NULL, pal_rev = FALSE, col_method = NULL,
  col_cuts = NULL, col_na = TRUE, x_balance = FALSE,
  x_zero = FALSE, x_zero_line = NULL, x_trans = "identity",
  x_labels = waiver(), x_pretty_n = 6, x_expand = NULL,
  y_balance = FALSE, y_expand = NULL, y_labels = waiver(),
  y_pretty_n = 5, y_trans = "identity", y_zero = FALSE,
  y_zero_line = NULL, title = "[Title]", subtitle = NULL,
  x_title = "[X title]", y_title = "[Y title]", col_title = "",
  caption = NULL, col_labels = NULL, col_legend_ncol = NULL,
  col_legend_nrow = NULL, col_labels_dp = 1,
  font_family = "Helvetica", font_size_title = NULL,
  font_size_body = NULL, title_wrap = 70, subtitle_wrap = 80,
  x_title_wrap = 50, y_title_wrap = 50, col_title_wrap = 25,
  caption_wrap = 80, mobile = 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.

col_var

Unquoted variable for points to be coloured by. Required input.

text_var

Unquoted variable to be used as a customised tooltip in combination with plotly::ggplotly(plot, tooltip = "text"). Defaults to NULL.

size_point

Size of points. Defaults to 1.

pal

Character vector of hex codes. Defaults to viridis. Use the pals package to find a suitable palette.

pal_rev

Reverses the palette. Defaults to FALSE.

col_method

The method of colouring features, either "bin", "quantile" or "category." If numeric, defaults to "quantile".

col_cuts

A vector of cuts to colour a numeric variable. If "bin" is selected, the first number in the vector should be either -Inf or 0, and the final number Inf. If "quantile" is selected, the first number in the vector should be 0 and the final number should be 1. Defaults to quartiles.

col_na

TRUE or FALSE of whether to show NA values of the colour variable. Defaults to TRUE.

x_balance

Add balance to the x axis so that zero is in the centre of the x scale.

x_zero

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

x_zero_line

TRUE or FALSE whether to add a zero reference line to the x axis. TRUE if there are positive and negative values in x_var. Otherwise defaults to FALSE.

x_trans

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

x_labels

Adjust the x scale labels through a function or vector.

x_pretty_n

The desired number of intervals on the x axis, as calculated by the pretty algorithm. Defaults to 6. Not applicable where mobile equals TRUE.

x_expand

A vector of range expansion constants used to add some padding on the x scale.

y_balance

Add balance to the y axis so that zero is in the centre of the y scale.

y_expand

A vector of range expansion constants used to add some padding on the y scale.

y_labels

Adjust the y scale labels through a function or vector.

y_pretty_n

The desired number of intervals on the y axis, as calculated by the pretty algorithm. Defaults to 5.

y_trans

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

y_zero

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

y_zero_line

TRUE or FALSE whether to add a zero reference line to the y axis. TRUE if there are positive and negative values in y_var. Otherwise defaults to FALSE.

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

col_title

Colour title string for the legend. Defaults to NULL.

caption

Caption title string. Defaults to NULL.

col_labels

Adjust the colour scale labels through a vector.

col_legend_ncol

The number of columns in the legend.

col_legend_nrow

The number of rows in the legend.

col_labels_dp

Select the appropriate number of decimal places for numeric variable auto legend labels. Defaults to 1.

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.

title_wrap

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

subtitle_wrap

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

x_title_wrap

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

y_title_wrap

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

col_title_wrap

Number of characters to wrap the colour title to. Defaults to 25. Not applicable where mobile equals TRUE.

caption_wrap

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

mobile

Whether the plot is to be displayed on a mobile device. Defaults to FALSE. If within an app with the mobileDetect function, then use mobile = input$isMobile.

Value

A ggplot object.

Examples

Run this code
# NOT RUN {
library(dplyr)

plot_data <- slice_sample(ggplot2::diamonds, prop = 0.05)

ggplot_point_col(plot_data, carat, price, color)

# }

Run the code above in your browser using DataLab