wyz.code.rdoc (version 1.1.19)

generateOptionLink: Generate Option Link

Description

Generate cross reference in R documentation

Usage

generateOptionLink(options_s_1, topicName_s_1, escapeBraces_b_1 = FALSE)

Arguments

options_s_1

A single string value that is generally a package name

topicName_s_1

A single string value that is the generally a function name

escapeBraces_b_1

A single boolean value, asking to escape braces

Value

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

References

Refer to Writing R extensions section 2.5, to know more about using cross references in R documentation.

Examples

# NOT RUN {
# Typical use case
generateOptionLink('myPackage', 'myFunction')
#[1] "\\link[myPackage]{myFunction}"

# Refer to reference R documentation for following case
generateOptionLink('=terms.object', 'terms')
#[1] "\\link[=terms.object]{terms}"
# }