uses_stats: Does a plot use one or more stats?

In rstudio-education/ggcheck: Inspect 'ggplot2' Plots for Automated Grading in Learning Exercises

Does a plot use one or more stats?

Description

uses_stats tests whether a plot uses one or more stats in its layers.

Usage

uses_stats(p, stats, geoms = NULL, exact = TRUE)

Arguments

p	A ggplot object
stats	A vector of character strings. Each element should correspond to the suffix of a ggplot2 stat_ function, e.g. c("identity", "smooth").
geoms	A character vector to optionally check for the geoms corresponding to stats e.g. c("point", "smooth") if checking c("identity", "smooth")
exact	if TRUE, use exact matching

Details

By default, the plot must have the exact stats or geom/stat combinations and in the same order. However, if exact is set to FALSE, the plot stats or geom/stat combinations do not have to be exact.

Value

TRUE or FALSE

See Also

Other functions for checking stats: get_stats(), ith_stat_is(), ith_stat()

Examples

require(ggplot2)
p <- ggplot(data = mpg, mapping = aes(x = displ, y = hwy)) +
  geom_point(mapping = aes(color = class)) +
  geom_smooth()
uses_stats(p, stats = "smooth")
uses_stats(p, stats = c("identity", "smooth"), exact = TRUE)
uses_stats(p, c("smooth", "identity"), geoms = c("smooth", "point"))

rstudio-education/ggcheck documentation built on May 12, 2023, 11:33 a.m.