pdfDisplay: Generates PDF and SVG figures

In StratigrapheR: Integrated Stratigraphy

Generates PDF and SVG figures

Description

Takes an ensemble of figures, represented by a function g(), and generates a PDF (or SVG if specified). The PDF can be visualised immediatly on the default PDF reader.

Usage

pdfDisplay(
  g,
  name,
  ext = ".pdf",
  dir = tempdir(),
  width = 10,
  height = 10,
  parg = list(),
  track = T,
  openfile = T,
  output = F,
  warn = F
)

Arguments

g	the plot function to be exported and looked at
name	the name of the document
ext	the extension of the document: ".pdf" by default, but ".svg" works also.
dir	the file where the document will be saved (by default a temporary directory, tempdir())
width	the width of the drawing area (in inches)
height	the height of the drawing area (in inches)
parg	list of arguments transmitted to the par() function
track	whether to generate different files for each rerun of pdfDisplay with identical 'name'. The name will be followed by '_(i)' where i is the version number. With this you avoid closing your pdf file at each rerun if your pdf reader is not able to deal with (to my knowledge only SumatraPDF is able)
openfile	should the pdf file be opened (for the moment works only in Windows). Use SumatraPDF as default pdf reader to be able to write over current file
output	whether to output the output of g() or not
warn	useless vestigial parameter, kept for compatibility with StratigrapheR 0.0.1

Details

The width and height you provide will not exactly be respected. I could not find a pdf printing function that respects dimensions scrupulously for R base graphics.

Value

the output of the g() function if output = TRUE

Examples

## Not run: 
temp <- tempfile()
dir.create(temp)

g1   <- function() plot(1,1)

pdfDisplay(g1(),"TestGraph", dir = temp,
           parg = list(mar = c(6,6,6,6), ps = 24,lwd = 4))

g1   <- function() plot(1,1, col = "red")

pdfDisplay(g1(), "TestGraph", dir = temp,
           parg = list(mar = c(6,6,6,6), ps = 24,lwd = 4))
## End(Not run)

StratigrapheR documentation built on July 9, 2023, 6:02 p.m.