generateSection: Generate Section

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

Description

Generate R documentation section

Usage

generateSection(sectionName_s_1, content_s)

Arguments

sectionName_s_1	A single string value
content_s	An unconstrained vector of string values

Value

A single string, containing the generated reference text. Can be appended several times to elaborate a multiple reference text.

See references and examples below.

Classification

STRATUM ▶ LAYER_1

PHASING ▶ BUILD

INTENT ▶ PARTS_BUILDING

Note

This function should not be used directly unless you need to write your own manual page generation program.

To generate a manual page directly, you would better use produceManualPage.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

References

Refer to Writing R extensions to know more about using web references in R documentation.

Refer to Parsing Rd files by Duncan Murdoch.

Examples

generateSection('concept', 'meta programming')
# "\\concept{meta programming}"

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