ltx_plot: Prints a R plot to a latex file or console

In R3port: Report Functions to Create HTML and PDF Files

Prints a R plot to a latex file or console

Description

This function makes a latex document including the plots defined

Usage

ltx_plot(
  plot,
  out,
  title = "plot",
  titlepr = NULL,
  footnote = "",
  plotnote = "",
  lwidth = NULL,
  pwidth = 10,
  pheight = 5.5,
  res = NULL,
  hyper = TRUE,
  outfmt = "pdf",
  fontsize = 12,
  units = "px",
  rawout = paste0(out, ".rawtex"),
  linebreak = TRUE,
  label = NULL,
  captpl = "top",
  rotate = FALSE,
  cleancur = FALSE,
  titlesub = NULL,
  ...
)

Arguments

plot	plot object or function call that creates plot to be printed to file
out	filename for the output latex file
title	character string to define the title of the plot which will be added to the caption
titlepr	character string to define the prefix of the title. Can be used to create custom numbering
footnote	character string with the footnote to be placed in the footer of the page (LaTeX coding can be used for example to create line breaks)
plotnote	character string with the plot note to be placed directly below the plot (LaTeX coding can be used for example to create line breaks)
lwidth	character string indicating the width of the plot within latex (e.g. "\\linewidth")
pwidth	numeric indicating the width of the plot to be generated in inches or pixels (for respectively the extensions pdf and png)
pheight	numeric indicating the height of the plot to be generated in inches or pixels (for respectively the extensions pdf and png)
res	numeric indicating the resolution of the plot (in case png is used), if set to NULL it will adapt the value according height of the plot
hyper	logical indicating if a hypertarget should be set used for bookmarks
outfmt	character string indicating the format of the output file (currently "pdf" and "png" are accepted)
fontsize	character string with the default font or pointsize passed through to png or pdf function
units	character string with the units to use for plot width and height passed through to png function
rawout	character string with the name of the raw latex file to generate (e.g. only plot code with no preamble and document ending) In case NULL no raw output will be generated. In order to combine results the filename should end in .rawtex
linebreak	logical indicating if a linebreak (clearpage) should be given after a plot
label	character with the label to add after the caption for referencing the table in text
captpl	character with the caption placement, can be either "top" or "bottom"
rotate	logical indicating if the resulting figure should be rotated 90 degrees clockwise
cleancur	logical indicating if the available plots should be deleted before creating new ones
titlesub	character string to define the subtext after title in footnotesize
...	additional arguments passed through to ltx_doc. Most important are template, rendlist, compile and show

Value

The function returns a latex file (or writes output to console)

Examples

# It is convenient to have an object for the plot argument
## Not run: 
  data(Theoph)
  library(ggplot2)
  pl <- qplot(Time, conc, data=Theoph, facets=~Subject,geom="line")
  ltx_plot(pl,out=tempfile(fileext=".tex"))

  # Base plots work a bit different and can be placed
  # in the function directly or wrapped in a function
  pl <- function() {
    plot(conc~Time,data=Theoph)
    title(main="a plot")
  }
  ltx_plot(pl(),out=tempfile(fileext=".tex"))
  # In case of big data it can be more convenient to have a png included
  ltx_plot(plot(rnorm(1e6)),out=tempfile(fileext=".tex"),
           outfmt="png",pwidth=2000,pheight=1200)

## End(Not run)

R3port documentation built on Sept. 22, 2023, 9:06 a.m.