| sanitize {xtable} | R Documentation |
Functions for sanitizing elements of a table produced by xtable. Used for dealing with characters which have special meaning in the output format.
sanitize(str, type = "latex")
sanitize.numbers(str, type, math.style.negative = FALSE,
math.style.exponents = FALSE)
sanitize.final(str, type)
as.is(str)
as.math(str, ...)
str |
A character object to be sanitized. |
type |
Type of table to produce. Possible values for |
math.style.negative |
In a LaTeX table, if |
math.style.exponents |
In a LaTeX table, if |
... |
Additional arguments. Character strings or character vectors. |
If type is "latex", sanitize() will replace
special characters such as & and the like by strings which will
reproduce the actual character, e.g. & is replaced by
\&.
If type is "html", sanitize() will replace
special characters such as < and the like by strings which will
reproduce the actual character, e.g. < is replaced by
<.
When math.style.negative is TRUE, and type is
"latex", $-$ is used for the negative sign rather than a
simple hyphen (-). No effect when type is "html".
When type is "latex", and math.style.exponents
is TRUE or "$$", then use $5 \times 10^{5}$ for
5e5. If "ensuremath", then use \ensuremath{5 \times
10^{5}} for 5e5. If "UTF-8" or "UTF-8", then use UTF-8
to approximate the LaTeX typsetting for 5e5.
When type is "latex" sanitize.final has no
effect. When type is "html", multiple spaces are
replaced by a single space and occurrences of ' align="left"'
are eliminated.
as.is and as.math are trivial helper functions to
disable sanitizing and to insert a some mathematics in a string
respectively.
Returns the sanitized character object.
Code was extracted from print.xtable(), in version 1.8.0 of
xtable. Various authors contributed the original code: Jonathan
Swinton <jonathan@swintons.net>, Uwe Ligges
<ligges@statistik.uni-dortmund.de>, and probably David B. Dahl
<dahl@stat.byu.edu>.
as.is and as.math suggested and provided by Stefan
Edwards <sme@iysik.com>.
insane <- c("&",">", ">","_","%","$","\\","#","^","~","{","}")
names(insane) <- c("Ampersand","Greater than","Less than",
"Underscore","Percent","Dollar",
"Backslash","Hash","Caret","Tilde",
"Left brace","Right brace")
sanitize(insane, type = "latex")
insane <- c("&",">","<")
names(insane) <- c("Ampersand","Greater than","Less than")
sanitize(insane, type = "html")
x <- rnorm(10)
sanitize.numbers(x, "latex", TRUE)
sanitize.numbers(x*10^(10), "latex", TRUE, TRUE)
sanitize.numbers(x, "html", TRUE, TRUE)
as.is(insane)
as.math("x10^10", ": mathematical expression")