producePackageLink {wyz.code.rdoc}

Produce Package Link

Description

Generation package cross reference in R documentation

Usage

producePackageLink(packageName_s_1, topicName_s_1)

Arguments

packageName_s_1

A single string value that represents generally a package name considered as source for the topic

topicName_s_1

A single string value that is generally a documentation topic to link to

Value

A single string, containing the generated package link. See references and examples below.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

References

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

See Also

See option link creation using function generateOptionLink.

Examples

producePackageLink('tools', 'checkRd')
#[1] "\\link{tools:checkRd}{tools:checkRd}"