---
title: "Using the pagenum package"
author: "Kevin Wright"
date: "`r Sys.Date()`"
bibliography: pagenum.bib
output:
  rmarkdown::html_vignette:
vignette: >
  %\VignetteIndexEntry{Using the pagenum package}
  %\VignetteEncoding{UTF-8}
  %\VignetteEngine{knitr::rmarkdown}
---

# Abstract

Sometimes it can be useful to add a footnote number to graphics.  This package
makes it easy to automatically add a time-stamp and page number to graphics.
The package can also be used to add general text anywhere on any type of
graphics device (base/lattice/ggplot).

# R setup

```{r setup, message=FALSE}
library("knitr")
knitr::opts_chunk$set(fig.align="center", fig.width=6, fig.height=6)
library("pagenum")
```
## Base graphics

First, set the starting page number to 1.  Each call of the `pagenum()`
function will add the page number to the current graphic and automatically
increment the page number counter which is stored in `options()`.

```{r base}
setPagenum(1)
plot(Sepal.Length~Sepal.Width, data=iris, col=Species, pch=19)
pagenum()
```

If the argument `num=""` is used, then the page counter is not automatically
incremented.

## Multiple figures with 'Draft' watermark
```{r multi}
op = par(mfrow=c(1,2))
plot(Sepal.Length ~ Sepal.Width, data=iris, col=Species, pch=19)
plot(Petal.Length ~ Petal.Width, data=iris, col=Species, pch=19)
par(op)
pagenum(num="", text="Figures 2a, 2b")
pagenum(num="", text="Draft",
        x=.5, y=.95, just=c('center','top'),
        col="wheat", cex=3)
```

## lattice with timestamp
```{r lattice}
setPagenum(getPagenum()+1) # Manual increment
library("lattice")
xyplot(Sepal.Length~Sepal.Width, data=iris, groups=Species)
pagenum(date=TRUE)
```

## ggplot2 with stamp at top right

```{r ggplot}
library("ggplot2")
ggplot(iris, aes(x=Sepal.Width, y=Sepal.Length,
                 color=Species)) + geom_point() + theme_classic()
pagenum(text="ABC Corp - ", date=TRUE,
        x=.95, y=.95, just=c('right','top'))
```

## Acknowledgements

Thanks for help from Paul Murrell.


## References