tikzDevice (version 0.12.6)

sanitizeTexString: Replace LaTeX Special Characters in a String

Description

This function is used by tikzDevice when sanitize = TRUE to replace special LaTeX characters (such as the comment character %) in plotting text where the user does not have direct control over the generated text.

Usage

sanitizeTexString(
  string,
  strip = getOption("tikzSanitizeCharacters"),
  replacement = getOption("tikzReplacementCharacters")
)

Value

sanitizedString

A character vector of length 1 with all special characters replaced.

Arguments

string

A character vector of length 1 (a string).

strip

A character vector of single characters to search for.

replacement

A character vector of replacement values.

Author

Cameron Bracken

Details

sanitizeTexString() searches character by character through a string replacing each occurrence of a special character contained in strip[i] with the corresponding replacement value in replacement[i]. tikzDevice calls back this function for every piece of text when the sanitize option is TRUE. See tikz() for more information on the default special characters and replacement values.

By default, tikzSanitizeCharacters replaces the following characters:

• %

• $

• }

• {

• ^

• _

• #

• &

• ~

With the contents of tikzReplacementCharacters:

• \%

• \$

• \}

• \{

• \^{}

• \_{}

• \#

• \&

• \char`\~

These defaults may be adjusted using the options() function.

See Also

tikz()