wyz.code.rdoc (version 1.1.7)

generateSection: Generate a R documentation section

Description

Generate a R documentation section

Usage

generateSection(sectionName_s_1, content_s)

Arguments

sectionName_s_1

the section name to consider. Must be known from rdocKeywords.

content_s

the section textual content to consider

Value

A single string.

Details

Sections inlining is automated and managed internally. Do not bother about it.

References

Refer to Writing R extensions to know more about R documentation requirements.

Examples

# NOT RUN {
print(generateReference(list(url = 'https://neonira.github.io/offensiveProgrammingBook/',
                             label = 'Offensive Programming Book')))
# provides following result
# "Refer to \href{https://neonira.github.io/offensiveProgrammingBook/}{Offensive Programming Book}."
# }