Description Usage Arguments Value Classification Author(s) References See Also Examples
View source: R/generateOptionLink.R
Generate cross reference in R documentation
1 | generateOptionLink(options_s_1, topicName_s_1, escapeBraces_b_1 = FALSE)
|
options_s_1 |
A single string value |
topicName_s_1 |
A single string value |
escapeBraces_b_1 |
A single boolean value |
A single string, containing one option link. See references and examples below.
STRATUM ▶ LAYER_1
PHASING ▶ BUILD
INTENT ▶ PARTS_BUILDING
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
Refer to Writing R extensions section 2.5, to know more about using cross references in R documentation.
See package link creation using function producePackageLink
.
1 2 | generateOptionLink('=terms.object', 'terms')
#[1] "\\link[=terms.object]{terms}"
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.