Try to coerce an object into a knitr_kable object

Description

coerce objects into a knitr_kable class object with a latex format

Usage

as.kable(x)

Arguments

Value

an object of class knitr_kable

Examples

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)

Build usepackage command for TeX document

Description

input TeX package name and optional package functions to create usepackage call

Usage

build_usepackage(pkg, options = NULL, uselibrary = NULL, chk.inst = FALSE)

Arguments

Details

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.

Value

character

Examples

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)
))

Check TeX Requirements for Package

Description

Checks if the required TeX libraries are installed on the system to render the internal tex file template.

Usage

check_requirements()

Value

logical

Examples

#check_requirements()

Get list of TeX packages installed on System

Description

Fetch all TeX packages currently installed on system

Usage

get_texpackages()

Details

If OS is Windows function checks against MikTex else function checks against TexLive.

Value

character

Examples

#head(get_texpackages())

Default and current tex options

Description

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.

Usage

tex_opts

tex_opts_current

Format

An object of class list of length 5.

An object of class list of length 5.

Details

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.

Note

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().

Examples

tex_opts$get()

Render and Preview snippets of TeX in R Viewer

Description

input TeX script into the function and it renders a pdf and converts it an image which is sent to Viewer.

Usage

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(),
  ...
)

Arguments

Details

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

Value

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

Examples

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))

}

Query TeX file for Required Packages

Description

Parse TeX file for usepackage calls and return a vector of the packages.

Usage

tex_requirements(
  file = system.file("tmpl.tex", package = "texPreview"),
  lines = NULL
)

Arguments

Details

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.

Value

character

Examples

tex_requirements()