beautify: Beautify R documentation content

Description Usage Arguments Value Classification Author(s) Examples

View source: R/beautify.R

Description

R documentation beautifying functions

Usage

1
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.

Classification

STRATUM ▶ LAYER_2

PHASING ▶ BUILD

INTENT ▶ PARTS_BUILDING

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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}

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