escapeContent: Escape Specials Characters In Content

Description Usage Arguments Value Classification Author(s) Examples

View source: R/escapeContent.R

Description

Manage characters to be escaped in R documentation text

Usage

1
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 to escape braces also

Value

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

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

Classification

STRATUM ▶ LAYER_1

PHASING ▶ BUILD

INTENT ▶ CONTENT_GENERATION

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

Examples

1
2
3
4
5
escapeContent('www@xxx.com')
# "www@@xxx.com"

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

neonira/wyz.code.rdoc documentation built on Feb. 19, 2020, 12:47 p.m.