ggFootnote: ggFootnote

Description Usage Arguments Value Examples

Description

ggFootnote adds a footnote or, more generally, text around the margins of a ggplot2 object

Usage

1
2
3
4
ggFootnote(plotObject, footnote, fileName = NULL, xLocation = "left",
  fontface = "plain", fonttype = "HersheySerif", fontcolor = "black",
  fontsize = 10, hjust = -0.1, vjust = 0.1, width_inch = 5,
  height_inch = 5, dpi = 600)

Arguments

plotObject

A ggplot2 object

fileName

filename to save the output object to. If NULL, then the object will be printed to the plots viewer and not saved.

xLocation

x axis location where the text should be added. Default is 'left'. Options are 'left', 'center', or 'right', or a numeric x-axis entry.

fontface

Font-face to be used. Default is 'plain', other options include 'bold', 'italic', 'bold.italic', etc

fonttype

Font-type to be used. Default is 'HersheySerif'

fontcolor

Font color to be used. Default is 'black'

fontsize

Fond size to use. Default is 10.

hjust

Horizontal fine-adjustment to alignment. Default is -.1.

vjust

Vertical fine-adjustment to alignment. Default is .1. Note that if you want the footnote at the top, you can use vjust to allow for gross-adjustment to the vertical alignment as well.

width_inch

If fileName is non-NULL, what should the width of the output plot file be.

height_inch

If fileName is non-NULL, what should the height of the output plot file be.

dpi

If fileName is non-NULL, what should the dpi of the output plot file be.

Value

A ggplot2/gridExtra object

Examples

1
#NULL

TaylorAndrew/atPlot documentation built on May 9, 2019, 4:23 p.m.