Package {xkcd}

Plotting 'ggplot2' Graphics in an 'XKCD' Style

Description

Provides custom geoms and themes to create charts and graphics in the distinctive, hand-drawn 'XKCD' webcomic style using the 'ggplot2' framework. The package utilizes custom layers for jittered lines, segments, circles, and figures, and includes a theme that supports the necessary 'XKCD' font.

Details

The DESCRIPTION file:

Index of help topics:

GeomXkcdRect            GeomXkcdRect: fuzzy rectangle geom (XKCD style)
geom_xkcdpath           GeomXkcdPath: fuzzy path/circle geom (XKCD
                        style)
theme_xkcd              Creates an XKCD theme
xkcd-package            Plotting 'ggplot2' Graphics in an 'XKCD' Style
xkcdaxis                Plot the axis
xkcdman                 Draw a stick figure
xkcdrect                Draw fuzzy rectangles

Author(s)

Emilio Torres-Manzanera [aut], Enrique Toledo [ctb, cre]

Maintainer: Enrique Toledo <enriquetoledo@gmail.com>

Examples

## Not run: vignette("xkcd-intro")

GeomXkcdRect: fuzzy rectangle geom (XKCD style)

Description

Draws each rectangle as a standard filled rect with four jittered, Bezier-smoothed border segments on top.

GeomXkcdPath: fuzzy path/circle geom (XKCD style)

Description

A ggplot2 geom that draws jittered, smoothed paths or fuzzy circles. It expects aesthetics like 'x', 'y', and either 'xend'/'yend' (for segments) or 'diameter' (for circles). Additional aesthetics (colour, alpha, linewidth, linetype) are respected.

Usage

geom_xkcdpath(
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "identity",
  ...,
  xjitteramount = 0.01,
  yjitteramount = 0.01,
  wobble = 1,
  seed = NULL,
  mask = TRUE,
  show.legend = NA,
  inherit.aes = TRUE
)

Arguments

Creates an XKCD theme

Description

This function creates an XKCD theme, applying the 'xkcd' font if available.

Usage

theme_xkcd()

Value

A theme object.

Note

The "xkcd" font must be installed on your system for the full effect. Modern graphics devices pick it up directly; registering it with extrafont is only needed for pdf/postscript output. See the vignette vignette("xkcd-intro") for installation instructions.

Examples

## Not run: 
# Assuming 'xkcd' font is installed and registered:
p <- ggplot(mtcars, aes(mpg, wt)) +
     geom_point() +
     theme_xkcd()
p

## End(Not run)

Plot the axis

Description

This function plots the axis in an XKCD style.

Usage

xkcdaxis(xrange, yrange, ...)

Arguments

Value

A list of layers containing the axes, coordinate system, and theme.

Examples

## Not run: 
xrange <- range(mtcars$mpg)
yrange <- range(mtcars$wt)
p <- ggplot() +
     geom_point(aes(mpg, wt), data=mtcars) +
     xkcdaxis(xrange,yrange)
p

## End(Not run)

Draw lines or circles

Description

Deprecated in favour of [geom_xkcdpath()], which integrates with ggplot2's aesthetic machinery instead of rebuilding mappings by hand. Migrate segments to 'geom_xkcdpath(aes(x = x, y = y, xend = xend, yend = yend), ...)' and circles to the 'diameter' aesthetic.

Usage

xkcdline(mapping, data, typexkcdline = "segment", mask = TRUE, ...)

Arguments

See Also

[geom_xkcdpath()]

Draw a stick figure

Description

Draws one stick figure per row of 'data'. The figure is built from eight fuzzy elements – a circular head plus seven bones (spine, two humeri, two radii and two legs) – which are emitted as just two [geom_xkcdpath()] layers.

Usage

xkcdman(mapping, data, seed = NULL, ...)

Arguments

Details

The following aesthetics are required, supplied through 'mapping' or as columns of 'data': 'x' and 'y' (centre of the head), 'scale' (overall size), 'ratioxy' (the x/y scale ratio, which keeps the figure from being distorted when the axes have different units), and the angles 'angleofspine', 'anglerighthumerus', 'anglelefthumerus', 'anglerightradius', 'angleleftradius', 'anglerightleg', 'angleleftleg' and 'angleofneck'.

See Also

[geom_xkcdpath()]

Draw fuzzy rectangles

Description

It draws fuzzy rectangles.

Usage

xkcdrect(
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "identity",
  ...,
  borderxjitteramount = 0.005,
  borderyjitteramount = 0.005,
  wobble = 1,
  seed = NULL,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE,
  fillcolour,
  bordercolour,
  borderlinewidth
)

Arguments

Details

This function draws rectangles with hand-drawn, wobbly borders.

The following aesthetics are required:

1. xmin

2. ymin

3. xmax

4. ymax

The fill and border are controlled with the standard fill, colour and linewidth aesthetics, so they may be mapped to variables in the usual way.

Value

A layer.

See Also

aes, geom_xkcdpath

Examples

## Not run: 
volunteers <- data.frame(year = c(2007:2011),
                         number = c(56470, 56998, 59686, 61783, 64251))

xrange <- range(volunteers$year)
yrange <- range(volunteers$number)

p <- ggplot() +
     xkcdrect(aes(xmin = year - 0.2,
                  xmax = year + 0.2,
                  ymin = number - 500,
                  ymax = number + 500),
              data = volunteers,
              fill = "pink",
              linewidth = 1.2) +
     geom_point(aes(x = year, y = number), data = volunteers) +
     xkcdaxis(xrange, yrange) +
     theme_xkcd()
p

## End(Not run)