Learn R Programming

simplevis (version 4.0.0)

gg_point_facet: Point ggplot that is facetted.

Description

Point ggplot that is facetted, but not coloured.

Usage

gg_point_facet(
  data,
  x_var,
  y_var,
  facet_var,
  text_var = NULL,
  size_point = 1,
  pal = NULL,
  title = NULL,
  title_wrap = 70,
  subtitle = NULL,
  subtitle_wrap = 80,
  x_balance = FALSE,
  x_expand = NULL,
  x_labels = NULL,
  x_na = TRUE,
  x_pretty_n = 3,
  x_rev = FALSE,
  x_title = NULL,
  x_title_wrap = 50,
  x_trans = "identity",
  x_zero = FALSE,
  x_zero_line = NULL,
  y_balance = FALSE,
  y_expand = NULL,
  y_labels = waiver(),
  y_na = TRUE,
  y_pretty_n = 4,
  y_title = NULL,
  y_title_wrap = 50,
  y_trans = "identity",
  y_zero = FALSE,
  y_zero_line = NULL,
  facet_labels = NULL,
  facet_na = TRUE,
  facet_ncol = NULL,
  facet_nrow = NULL,
  facet_scales = "fixed",
  caption = NULL,
  caption_wrap = 80,
  font_family = "",
  font_size_title = NULL,
  font_size_body = NULL
)

Arguments

data

An ungrouped summarised tibble or dataframe. Required input.

x_var

Unquoted variable to be on the x scale (i.e. character, factor, logical, numeric, date or datetime). Required input.

y_var

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

facet_var

Unquoted categorical variable to facet the data 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.

title

Title string. Defaults to NULL.

title_wrap

Number of characters to wrap the title to. Defaults to 70.

subtitle

Subtitle string.

subtitle_wrap

Number of characters to wrap the subtitle to. Defaults to 80.

x_balance

For a numeric x variable, add balance to the x scale so that zero is in the centre. Defaults to FALSE.

x_expand

A vector of range expansion constants used to add padding to the x scale, as per the ggplot2 expand argument in ggplot2 scales functions.

x_labels

A function or vector to modify x scale labels, as per the ggplot2 labels argument in ggplot2 scales functions. If NULL, categorical variable labels are converted to sentence case. Use ggplot2::waiver() to keep x labels untransformed.

x_na

TRUE or FALSE of whether to include x_var NA values. Defaults to TRUE.

x_pretty_n

For a numeric or date x variable, the desired number of intervals on the x scale, as calculated by the pretty algorithm. Defaults to 3.

x_rev

For a categorical x variable, TRUE or FALSE of whether the x variable variable is reversed. Defaults to FALSE.

x_title

X scale title string. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.

x_title_wrap

Number of characters to wrap the x title to. Defaults to 50.

x_trans

For a numeric x variable, a string specifying a transformation for the x scale, such as "log10" or "sqrt". Defaults to "identity".

x_zero

For a numeric x variable, TRUE or FALSE of whether the minimum of the x scale is zero. Defaults to FALSE.

x_zero_line

For a numeric x variable, TRUE or FALSE of whether to add a zero reference line to the x scale. Defaults to TRUE if there are positive and negative values in x_var. Otherwise defaults to FALSE.

y_balance

For a numeric y variable, add balance to the y scale so that zero is in the centre of the y scale.

y_expand

A vector of range expansion constants used to add padding to the y scale, as per the ggplot2 expand argument in ggplot2 scales functions.

y_labels

A function or vector to modify y scale labels, as per the ggplot2 labels argument in ggplot2 scales functions. If NULL, categorical variable labels are converted to sentence case. Use ggplot2::waiver() to keep y labels untransformed.

y_na

TRUE or FALSE of whether to include y_var NA values. Defaults to TRUE.

y_pretty_n

For a numeric or date x variable, the desired number of intervals on the x scale, as calculated by the pretty algorithm. Defaults to 4.

y_title

y scale title string. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.

y_title_wrap

Number of characters to wrap the y title to. Defaults to 50.

y_trans

For a numeric y variable, a string specifying a transformation for the y scale, such as "log10" or "sqrt". Defaults to "identity".

y_zero

For a numeric y variable, TRUE or FALSE of whether the minimum of the y scale is zero. Defaults to TRUE.

y_zero_line

For a numeric y variable, TRUE or FALSE whether to add a zero reference line to the y scale. Defaults to TRUE if there are positive and negative values in y_var. Otherwise defaults to FALSE.

facet_labels

As per the ggplot2 labeller argument within the ggplot facet_wrap function. If NULL, defaults to ggplot2::as_labeller(snakecase::to_sentence_case). Use facet_labels = ggplot2::label_value to turn off default sentence case transformation.

facet_na

TRUE or FALSE of whether to include facet_var NA values. Defaults to TRUE.

facet_ncol

The number of columns of facetted plots.

facet_nrow

The number of rows of facetted plots.

facet_scales

Whether facet_scales should be "fixed" across facets, "free" in both directions, or free in just one direction (i.e. "free_x" or "free_y"). Defaults to "fixed".

caption

Caption title string.

caption_wrap

Number of characters to wrap the caption to. Defaults to 80.

font_family

Font family to use. Defaults to "".

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.

Value

A ggplot object.

Examples

Run this code
# NOT RUN {
library(simplevis)
library(palmerpenguins)

gg_point_facet(penguins, bill_length_mm, body_mass_g, species)

# }

Run the code above in your browser using DataLab