Skip to contents

Sketchy smoothed conditional mean

Source: R/geom-sketch-smooth.R
geom_sketch_smooth.Rd

Draws a hand-drawn fitted line with an optional roughened confidence band — the sketch analogue of ggplot2::geom_smooth(). The fit is computed by ggplot2::stat_smooth() (method, formula, se, etc. pass through).

Usage

GeomSketchSmooth

geom_sketch_smooth(
  mapping = NULL,
  data = NULL,
  stat = "smooth",
  position = "identity",
  ...,
  method = NULL,
  formula = NULL,
  se = TRUE,
  roughness = 1,
  bowing = 1,
  n_passes = 2L,
  seed = NULL,
  fill_style = "hachure",
  hachure_angle = 45,
  hachure_gap = NULL,
  fill_weight = 0.5,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)

Format

An object of class GeomSketchSmooth (inherits from Geom, ggproto, gg) of length 6.

Arguments

mapping

Set of aesthetic mappings created by ggplot2::aes().

data

Data to display.

stat

Statistical transformation. Default "identity".

position

Position adjustment. Default "identity".

...

Other arguments passed on to the layer.

method, formula, se

Passed to ggplot2::stat_smooth(). se = TRUE draws the roughened confidence band.

roughness

Non-negative roughness (0 = straight). Default 1.

bowing

Non-negative bowing multiplier. Default 1.

n_passes

Number of stroke passes. Default 2.

seed

Integer seed. NULL uses getOption("ggsketch.seed", 1L).

fill_style

Fill style for the confidence band. Default "hachure".

hachure_angle

Fill line angle in degrees. Default 45.

hachure_gap

Fill line gap in npc units (NULL = 6% of diagonal).

fill_weight

Stroke weight for fill lines. Default 0.5.

na.rm

Remove missing values silently? Default FALSE.

show.legend

Logical; include in legend?

inherit.aes

Override default aesthetics?

See also

Other sketch-geoms: GeomSketchAbline, GeomSketchBoxplot, GeomSketchBracket, GeomSketchCol, GeomSketchCurve, GeomSketchEllipse, GeomSketchHex, GeomSketchLine, GeomSketchLinerange, GeomSketchPath, GeomSketchPoint, GeomSketchPolygon, GeomSketchRect, GeomSketchRibbon, GeomSketchRug, GeomSketchSegment, GeomSketchSpoke, GeomSketchViolin, annotate_sketch(), geom_sketch_bin2d(), geom_sketch_contour(), geom_sketch_count(), geom_sketch_density(), geom_sketch_density2d(), geom_sketch_function(), geom_sketch_histogram(), geom_sketch_jitter(), geom_sketch_qq(), geom_sketch_quantile(), geom_sketch_text()

Examples

library(ggplot2)
ggplot(mtcars, aes(wt, mpg)) +
  geom_sketch_point(seed = 1L) +
  geom_sketch_smooth(method = "lm", formula = y ~ x, seed = 2L) +
  theme_sketch()