| Title: | Compile and Preview Snippets of 'LaTeX' |
|---|---|
| Description: | Compile snippets of 'LaTeX' directly into images from the R console to view in the 'RStudio' viewer pane, Shiny apps and 'RMarkdown' documents. |
| Authors: | Jonathan Sidi [aut, cre], Daniel Polhamus [aut] |
| Maintainer: | Jonathan Sidi <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 2.1.0 |
| Built: | 2024-09-21 03:08:38 UTC |
| Source: | https://github.com/yonicd/texpreview |
coerce objects into a knitr_kable class object with a latex format
as.kable(x)as.kable(x)
x |
object, can be tex character, object return by returnType = "input", or a path to a tex file. |
an object of class knitr_kable
tex <- '\\begin{tabular}{llr} \\hline \\multicolumn{2}{c}{Item} \\\\ \\cline{1-2} Animal & Description & Price (\\$) \\\\ \\hline Gnat & per gram & 13.65 \\\\ & each & 0.01 \\\\ Gnu & stuffed & 92.50 \\\\ Emu & stuffed & 33.33 \\\\ Armadillo & frozen & 8.99 \\\\ \\hline \\end{tabular}' ktex <- as.kable(tex) class(ktex) attributes(ktex) ktex # file path toy <- system.file('examples/toy/toy.tex',package = 'texPreview') ktex_path <- as.kable(toy) class(ktex_path) attributes(ktex_path) ktex_path # texpreview_input class # this is the same output class as one would get with # tex_preview(tex,returnType = 'input') toy_input <- structure(sprintf('\\input{%s}',toy),class = 'texpreview_input') toy_input as.kable(toy_input)tex <- '\\begin{tabular}{llr} \\hline \\multicolumn{2}{c}{Item} \\\\ \\cline{1-2} Animal & Description & Price (\\$) \\\\ \\hline Gnat & per gram & 13.65 \\\\ & each & 0.01 \\\\ Gnu & stuffed & 92.50 \\\\ Emu & stuffed & 33.33 \\\\ Armadillo & frozen & 8.99 \\\\ \\hline \\end{tabular}' ktex <- as.kable(tex) class(ktex) attributes(ktex) ktex # file path toy <- system.file('examples/toy/toy.tex',package = 'texPreview') ktex_path <- as.kable(toy) class(ktex_path) attributes(ktex_path) ktex_path # texpreview_input class # this is the same output class as one would get with # tex_preview(tex,returnType = 'input') toy_input <- structure(sprintf('\\input{%s}',toy),class = 'texpreview_input') toy_input as.kable(toy_input)
input TeX package name and optional package functions to create usepackage call
build_usepackage(pkg, options = NULL, uselibrary = NULL, chk.inst = FALSE)build_usepackage(pkg, options = NULL, uselibrary = NULL, chk.inst = FALSE)
pkg |
character, name of TeX package |
options |
character, name(s) of options to use in the package |
uselibrary |
character, part of document preamble to specify a uselibrary call related to package |
chk.inst |
logical, invokes a check to see if pkg is currently installed on system (default FALSE) |
if options and uselibrary are NULL (default) then only the call for the package is returned. See the TeX wikibook for more information https://en.wikibooks.org/wiki/LaTeX/Document_Structure#Packages on the usepackage command. If chk.inst finds that the package is not installed on system function returns NULL.
character
build_usepackage(pkg = 'xcolor') build_usepackage(pkg = 'xcolor',options = 'usenames') #build many at once using mapply geom.opts=c('paperwidth=35cm','paperheight=35cm','left=2.5cm','top=2.5cm') use.opts="\\usetikzlibrary{mindmap,backgrounds}" unlist(mapply(build_usepackage, pkg = list('times','geometry','tikz'), options= list(NULL ,geom.opts ,NULL), uselibrary = list(NULL ,NULL ,use.opts) ))build_usepackage(pkg = 'xcolor') build_usepackage(pkg = 'xcolor',options = 'usenames') #build many at once using mapply geom.opts=c('paperwidth=35cm','paperheight=35cm','left=2.5cm','top=2.5cm') use.opts="\\usetikzlibrary{mindmap,backgrounds}" unlist(mapply(build_usepackage, pkg = list('times','geometry','tikz'), options= list(NULL ,geom.opts ,NULL), uselibrary = list(NULL ,NULL ,use.opts) ))
Checks if the required TeX libraries are installed on the system to render the internal tex file template.
check_requirements()check_requirements()
logical
#check_requirements()#check_requirements()
Fetch all TeX packages currently installed on system
get_texpackages()get_texpackages()
If OS is Windows function checks against MikTex else function checks against TexLive.
character
#head(get_texpackages())#head(get_texpackages())
Options for functions in the texPreview package. When running R code, the object tex_opts
(default options) is not modified by chunk headers (local chunk options are
merged with default options), whereas tex_opts_current (current options)
changes with different chunk headers and it always reflects the options for
the current chunk.
tex_opts tex_opts_currenttex_opts tex_opts_current
An object of class list of length 5.
An object of class list of length 5.
Normally we set up the global options once in the first code chunk in a
document using tex_opts$set(), so that all latter chunks will
use these options. Note the global options set in one chunk will not affect
the options in this chunk itself, and that is why we often need to set global
options in a separate chunk.
Below is a list of default chunk options, retrieved via
tex_opts$get():
These options correspond to fields in the direct call to tex_preview, which are listed in explained
in the help manual.
tex_opts_current is read-only in the sense that it does nothing if
you call tex_opts_current$set(); you can only query the options via
tex_opts_current$get().
tex_opts$get()tex_opts$get()
input TeX script into the function and it renders a pdf and converts it an image which is sent to Viewer.
tex_preview( obj, tex_lines = NULL, stem = "tex_temp", overwrite = TRUE, keep_pdf = FALSE, tex_message = FALSE, fileDir = tex_opts$get("fileDir"), margin = tex_opts$get("margin"), imgFormat = tex_opts$get("imgFormat"), returnType = tex_opts$get("returnType"), resizebox = tex_opts$get("resizebox"), usrPackages = tex_opts$get("usrPackages"), engine = tex_opts$get("engine"), cleanup = tex_opts$get("cleanup"), density = tex_opts$get("density"), svg_max = tex_opts$get("svg_max"), print.xtable.opts = tex_opts$get("print.xtable.opts"), opts.html = tex_opts$get("opts.html"), markers = interactive(), ... )tex_preview( obj, tex_lines = NULL, stem = "tex_temp", overwrite = TRUE, keep_pdf = FALSE, tex_message = FALSE, fileDir = tex_opts$get("fileDir"), margin = tex_opts$get("margin"), imgFormat = tex_opts$get("imgFormat"), returnType = tex_opts$get("returnType"), resizebox = tex_opts$get("resizebox"), usrPackages = tex_opts$get("usrPackages"), engine = tex_opts$get("engine"), cleanup = tex_opts$get("cleanup"), density = tex_opts$get("density"), svg_max = tex_opts$get("svg_max"), print.xtable.opts = tex_opts$get("print.xtable.opts"), opts.html = tex_opts$get("opts.html"), markers = interactive(), ... )
obj |
object to convert to TeX script |
tex_lines |
vector of character, in case of special needs, instead of asking texPreview to build up, you may choose to pass in the contents of the complete LaTeX file directly. It should be a vector of character with each element as a line of raw TeX code. |
stem |
character, name to use in output files, Default: "tex_temp" |
overwrite |
logical, controls if overwriting of output stem* files given their existences, Default: TRUE |
keep_pdf |
logical, controls if the rendered pdf file should be kept or deleted, Default: FALSE |
tex_message |
logical, controls if latex executing messages are displayed in console. Default: FALSE |
fileDir |
character, output destination. If NULL a temp.dir() will be used and no output will be saved, Default: tex_opts$get('fileDir') |
margin |
table margin for pdflatex call, Default: tex_opts$get('margin') |
imgFormat |
character, defines the type of image the PDF is converted to Default: tex_opts$get('imgFormat') |
returnType |
character, one of "viewer", "html", or "tex" determining appropriate return type for the rendering process, Default: tex_opts$get('returnType') |
resizebox |
logical, forces a tabular tex object to be constrained on the margins of the document, Default: tex_opts$get('resizebox') |
usrPackages |
character, vector of usepackage commands, see details for string format |
engine |
character, specifies which latex to pdf engine to use ('pdflatex','xelatex','lualatex'), Default: tex_opts$get('engine') |
cleanup |
character, vector of file extensions to clean up after building pdf, Default: tex_opts$get('cleanup') |
density |
numeric, controls the density of the image. Default is 150: tex_opts$get('density) |
svg_max |
numeric, maximum svg file size allowable to preview, Default: tex_opts$get('svg_max') |
print.xtable.opts |
list, contains arguments to pass to print.table, relevant only if xtable is used as the input, Default: tex_opts$get('print.xtable.opts') |
opts.html |
list, html options, Default: tex_opts$get('opts.html') |
markers |
logical, if TRUE then RStudio markers will be invoked to create links for the log file on rendering errors, Default: interactive() |
... |
passed to system2 |
tex_preview is an S3 method that can be used to preview TeX output from different
object classes.
Built-in support includes:
character (tex lines)
knitr_kable (kable/kableExtra)
xtable
texreg
equatiomatic
The function assumes the system has pdflatex installed and it is defined in the PATH.
To add packages to the tex file on render there are two options
Use build_usepackage and use the input
argument usrPackages.
Append to the input object \\usepackage{...} calls, they will be parsed
and added the to rendering.
An image file of the name stem with the extension specified in imgFormat.
The default extension is png.
The function writes two files to disk in the fileDir
Image file
TeX script
The rendering files are removed up from the fileDir. This can
be controlled using the cleanup argument or tex_opts$get('cleanup')
The output of the function is dependent on the value of returnType:
viewer: NULL
magick image is printed in the internal viewer
tex:
character, TeX lines
printed 'asis' in RMarkdown
input: character
path to the file containing the tex wrapped in an input call
printed 'asis' in RMarkdown
html: magick image
Printed as an HTML document in the internal viewer
Printed as an image in RMarkdown
data('iris') if(interactive()){ # Raw TeX tex <- '\\begin{tabular}{llr} \\hline \\multicolumn{2}{c}{Item} \\\\ \\cline{1-2} Animal & Description & Price (\\$) \\\\ \\hline Gnat & per gram & 13.65 \\\\ & each & 0.01 \\\\ Gnu & stuffed & 92.50 \\\\ Emu & stuffed & 33.33 \\\\ Armadillo & frozen & 8.99 \\\\ \\hline \\end{tabular}' # knitr kable mtcars |> head() |> knitr::kable("latex") |> tex_preview() # with svg output pan/zoom is enabled in the internal viewer tex_preview(obj = tex,stem = 'eq',imgFormat = 'svg') # use tex_lines parameter to pass full document tikz_path <- system.file( 'examples/tikz/credit_rationing.tex', package = 'texPreview' ) tex_preview(tex_lines = readLines(tikz_path)) }data('iris') if(interactive()){ # Raw TeX tex <- '\\begin{tabular}{llr} \\hline \\multicolumn{2}{c}{Item} \\\\ \\cline{1-2} Animal & Description & Price (\\$) \\\\ \\hline Gnat & per gram & 13.65 \\\\ & each & 0.01 \\\\ Gnu & stuffed & 92.50 \\\\ Emu & stuffed & 33.33 \\\\ Armadillo & frozen & 8.99 \\\\ \\hline \\end{tabular}' # knitr kable mtcars |> head() |> knitr::kable("latex") |> tex_preview() # with svg output pan/zoom is enabled in the internal viewer tex_preview(obj = tex,stem = 'eq',imgFormat = 'svg') # use tex_lines parameter to pass full document tikz_path <- system.file( 'examples/tikz/credit_rationing.tex', package = 'texPreview' ) tex_preview(tex_lines = readLines(tikz_path)) }
Parse TeX file for usepackage calls and return a vector of the packages.
tex_requirements( file = system.file("tmpl.tex", package = "texPreview"), lines = NULL )tex_requirements( file = system.file("tmpl.tex", package = "texPreview"), lines = NULL )
file |
character, Path to TeX file, Default: system.file("tmpl.tex", package = "texPreview") |
lines |
character, character vector containing TeX script, Default: NULL |
If file is NULL then function will use the the value in lines. The default path used in file is the internal template that the package uses.
character
tex_requirements()tex_requirements()