wyz.code.rdoc (version 1.1.19)

escapeContent: Escape Specials Characters In Content

Description

Manage characters to be escaped in R documentation text

Usage

escapeContent(content_s_1, escapeBraces_b_1 = FALSE)

Arguments

content_s_1

A single string value that is the content to consider

escapeBraces_b_1

A single boolean value, allowing also to escape braces

Value

A single string with character '@' and '%' escaped.

When escapeBraces_b_1 is set, characters '{' and '}' are also escaped.

Examples

# NOT RUN {
escapeContent('[e-mail]')
# "www@@xxx.com"

escapeContent('\\code{ x %% y }', TRUE)
# "\\code\{ x \%\% y \}"
# }