R: Escape examples

escape_examples {roxygen2} | R Documentation

## Escape examples

### Description

This documentation topic is used primarily for testing and to record our understanding of the `\example{}` escaping rules. See https://developer.r-project.org/parseRd.pdf for the details provided by R core.

### Usage

    escape_examples(x)

### Examples

    # In examples we automatically escape Rd comments (%):
    100 %% 30
    # even if they are in strings
    "50%"

    # and \ and \v inside of strings and symbols
    "\v" # vertical tab
    "\\"
    # but not comments: \l \v

    # other string escapes are left as is
    "\""
    "\n"

    # Otherwise, backslashes and parentheses are left as is. This
    # means that you need to escape unbalanced parentheses, which typically only
    # occur in \dontshow{}:

    print("Hello")

    # You also need to escape backslashes in infix operators and comments
    # (this is generally rare)
    `%\\%` <- function(x, y) x + y
    10 %\% 20
    # \\ (renders as two backslashes)

[Package roxygen2 version 7.1.0 Index]