beautify {wyz.code.rdoc}

Beautify R documentation content

Description

R documentation beautifying functions

Usage

beautify(escapeBraces_b_1 = FALSE)

Arguments

escapeBraces_b_1

A single boolean value, allowing to escape braces also

Value

A named list of R vectorized functions. See examples below.

Content provided to function will be processed by function generateMarkup.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

Examples

b <- beautify()
cat('length', length(b), '\n')
#25

cat(names(b), '\n')
# acronym bold cite code dQuote email emph enc env figure file format kbd link
# option pkg preformatted samp source sQuote strong url var verb codelink

x <- 'some content'
cat(x, ':', b$code(x), '\n')
#some content : \code{some content}