generateOptionLink: Generate Option Link
In neonira/wyz.code.rdoc: Wizardry Code Offensive Programming R Documentation
Description
Usage
Arguments
Value
Classification
Author(s)
References
See Also
Examples
View source: R/generateOptionLink.R
Description
Generate cross reference in R documentation
Usage
1
generateOptionLink(options_s_1, topicName_s_1, escapeBraces_b_1 = FALSE)
Arguments
options_s_1
A single string value
topicName_s_1
A single string value
escapeBraces_b_1
A single boolean value
Value
A single string, containing one option link. See references and examples below.
Classification
STRATUM ▶ LAYER_1
PHASING ▶ BUILD
INTENT ▶ PARTS_BUILDING
Author(s)
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
References
Refer to
Writing R extensions
section 2.5, to know more about using cross references in R documentation.
See Also
See package link creation using function producePackageLink.
Examples
1
2
generateOptionLink('=terms.object', 'terms')
#[1] "\\link[=terms.object]{terms}"
neonira/wyz.code.rdoc documentation built on Feb. 19, 2020, 12:47 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Classification Author(s) References See Also Examples
View source: R/generateOptionLink.R
Description
Generate cross reference in R documentation
Usage
1 | generateOptionLink(options_s_1, topicName_s_1, escapeBraces_b_1 = FALSE)
|
Arguments
options_s_1 |
A single string value |
topicName_s_1 |
A single string value |
escapeBraces_b_1 |
A single boolean value |
Value
A single string, containing one option link. See references and examples below.
Classification
STRATUM ▶ LAYER_1
PHASING ▶ BUILD
INTENT ▶ PARTS_BUILDING
Author(s)
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
References
Refer to Writing R extensions section 2.5, to know more about using cross references in R documentation.
See Also
See package link creation using function producePackageLink.
Examples
1 2 | generateOptionLink('=terms.object', 'terms')
#[1] "\\link[=terms.object]{terms}"
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.