generateOptionSexpr: Generate Option Sexpr

In wyz.code.rdoc: Wizardry Code Offensive Programming R Documentation

Description

Generation option Sexpr in R documentation

Usage

generateOptionSexpr(options_s_1, topicName_s_1, escapeBraces_b_1 = FALSE)

Arguments

options_s_1	A single string value that is generally R code used to set expression options
topicName_s_1	A single string value that is the generally R code
escapeBraces_b_1	A single boolean value, asking to escape braces

Value

A single string, containing one option Sexpr. See references and examples below.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

References

Refer to Writing R extensions section 2.12, to know more about using Sexpr handling in R documentation.

Examples

generateOptionSexpr('echo=TRUE', 'x <- 1')
#[1] "\\Sexpr[echo=TRUE]{x <- 1}"

wyz.code.rdoc documentation built on Oct. 6, 2021, 9:07 a.m.