Description Usage Arguments Details Value Note Author(s) References See Also Examples
The TikZ device enables LaTeX-ready output from graphics
functions. This is done by encoding graphics commands
using TikZ markup. All text in a graphic output with
tikz
will be typeset by LaTeX and therefore will
match whatever fonts are currently used in the document.
This also means that LaTeX mathematics can be
typeset directly into labels and annotations.
1 2 3 4 5 6 7 8 | tikz(file = ifelse(onefile, "./Rplots.tex", "./Rplot%03d.tex"),
width = 7, height = 7, onefile = TRUE,
bg = "transparent", fg = "black", pointsize = 10,
standAlone = FALSE, bareBones = FALSE, console = FALSE,
sanitize = FALSE,
engine = getOption("tikzDefaultEngine"),
documentDeclaration = getOption("tikzDocumentDeclaration"),
packages, footer = getOption("tikzFooter"))
|
file |
A character string indicating the desired path to the output file. |
width |
The width of the output figure, in inches. |
height |
The height of the output figure, in inches. |
onefile |
Should output be directed to separate
environments in a single file (default |
bg |
The starting background color for the plot. |
fg |
The starting foreground color for the plot. |
pointsize |
Base pointsize used in the LaTeX
document. This option is only used if a valid pointsize
cannot be extracted from the value of
|
standAlone |
A logical value indicating whether the
output file should be suitable for direct processing by
LaTeX. A value of |
bareBones |
A logical value. When |
console |
Should the output of tikzDevice be
directed to the R console (default |
sanitize |
Should special latex characters be replaced (Default FALSE). See the section “Options That Affect Package Behavior” for which characters are replaced. |
engine |
a string specifying which TeX engine to use. Possible values are 'pdftex', 'xetex' and 'luatex'. See the Unicode section of tikzDevice-package for details. |
documentDeclaration |
See the sections “Options That Affect Package Behavior” and “Font Size Calculations” of tikzDevice-package for more details. |
packages |
See the section “Options That Affect Package Behavior” of tikzDevice-package. |
footer |
See the section “Options That Affect Package Behavior” of tikzDevice-package. |
The TikZ device currently supports three modes of output
depending on the value of the parameter standAlone
and bareBones
. If standAlone
and
bareBones
are set to the default value of
FALSE
, the resulting file will only contain
graphics output wrapped in a LaTeX tikzpicture
environment. Since this file is not a complete LaTeX
document, it will need to be included in another LaTeX
document using the \input
command. For example:
1 2 3 4 | \documentclass{article}
\usepackage{tikz} \begin{document} \begin{figure}
\centering \input{Rplots.tex} \caption{} \end{figure}
\end{document}
|
When standAlone
is set to TRUE
, the device
wraps the tikzpicture
environment in a complete
LaTeX document suitable for direct compilation. In this
mode the preview
package is used to crop the
resulting output to the bounding box of the graphic.
When bareBones
is set to TRUE
, the output
is not wrapped in a document or a tikzpicture
environment. This is useful for embedding an generated
graphic within an existing TikZ picture.
In cases where both standAlone
and
bareBones
have been set to TRUE
, the
standAlone
option will take precedence.
tikz()
returns no values.
To compile the output of tikz
a working
installation of LaTeX and PGF is needed. Current
releases of the TikZ package are available from
http://www.ctan.org. The package may also be
installed through the MikTeX package manager on Windows
or using the TeX Live package manager, tlmgr
, on
Unix/Linux/OS X. The TeX Live package manager will only
be installed by default for TeX Live distributions dated
2008 and later. Both bleeding-edge and release versions
of TikZ may be obtained from the project website hosted
at http://sourceforge.net/projects/pgf/.
Multiple plots will be placed as separate environments in the output file.
Charlie Sharpsteen source@sharpsteen.net and Cameron Bracken cameron.bracken@gmail.com
The TikZ and PGF Packages: Manual for version 2.00
http://sourceforge.net/projects/pgf
Till Tantau,
February 20, 2008
pictex
, getLatexCharMetrics
,
getLatexStrWidth
,
setTikzDefaults
,
tikzAnnotate
,
sanitizeTexString
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | ## Not run:
## Example 1 ###################################
#Set up temporary work directory
td <- tempdir()
tf <- file.path(td,'example1.tex')
oldwd <- getwd()
setwd(td)
# Minimal plot
tikz(tf,standAlone=TRUE)
plot(1)
dev.off()
# View the output
tools::texi2dvi(tf,pdf=T)
system(paste(getOption('pdfviewer'),file.path(td,'example1.pdf')))
setwd(oldwd)
################################################
## Example 2 ###################################
#Set up temporary work directory
td <- tempdir()
tf <- file.path(td,'example2.tex')
oldwd <- getwd()
setwd(td)
#LaTeX math symbol names
syms <-c('alpha','theta','tau','beta','vartheta','pi','upsilon',
'gamma','gamma','varpi','phi','delta','kappa','rho',
'varphi','epsilon','lambda','varrho','chi','varepsilon',
'mu','sigma','psi','zeta','nu','varsigma','omega','eta',
'xi','Gamma','Lambda','Sigma','Psi','Delta','Xi','Upsilon',
'Omega','Theta','Pi','Phi')
x <- rnorm(length(syms))
y <- rnorm(length(syms))
tikz(tf,standAlone=TRUE)
plot(-2:2, -2:2, type = "n", axes=F,
xlab='', ylab='', main='TikZ Device Math Example')
text(x,y,paste('\\\\Large$\\\\',syms,'$',sep=''))
dev.off()
#View the output
tools::texi2dvi(tf,pdf=TRUE)
system(paste(getOption('pdfviewer'),file.path(td,'example2.pdf')))
setwd(oldwd)
################################################
## Example 3 ###################################
#Set up temporary work directory
td <- tempdir()
tf <- file.path(td,'example3.tex')
oldwd <- getwd()
setwd(td)
tikz(tf,standAlone=TRUE)
plot(-2:2, -2:2, type = "n", axes=F, xlab='', ylab='', main='Random Circles')
points(rnorm(50), rnorm(50), pch=21,
bg=rainbow(50,alpha=.5), cex=10)
dev.off()
#View the output
tools::texi2dvi(tf,pdf=TRUE)
system(paste(getOption('pdfviewer'),file.path(td,'example3.pdf')))
setwd(oldwd)
################################################
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.