generateSpecialLink: Generate R documentation special link

Description Usage Arguments Value Note Author(s) References Examples

View source: R/generateSpecialLink.R

Description

Will create a special R documentation link on package name, using rare syntax \link[packagename:topicname]{packagename:topicname}.

Usage

1
generateSpecialLink(packageName_s_1, topicName_s_1)

Arguments

packageName_s_1

the package name to consider

topicName_s_1

the topic name to consider

Value

A single string.

Note

It is not possible to create such R documentation special link, using generateContent function.

Author(s)

Fabien Gelineau <[email protected]>

Maintainer: Fabien Gelineau <[email protected]>

References

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

Examples

1
print(generateSpecialLink('wyz.doc.offensiveProgramming', 'runTestCase'))

wyz.code.rdoc documentation built on Oct. 8, 2019, 9:05 a.m.