rk.rkh.link: Create XML "link" node for RKWard help pages

View source: R/rk.rkh.link.R

rk.rkh.linkR Documentation

Create XML "link" node for RKWard help pages

Description

Create XML "link" node for RKWard help pages

Usage

rk.rkh.link(href, text = NULL, type = "R", i18n = NULL)

Arguments

href

Character string, either the URL to link to, name of an R package or ID of another plugin (see type).

text

Character string, optional link text.

type

Character string, one of the following valid entries:

  • "url"href is assumend to be the actual URL.

  • "R"href is assumend to be the name of an R package, i.e., the link generated will look like rkward://rhelp/<href>.

  • "RK"href is assumend to be the ID of another RKWard plugin, i.e., the link generated will look like rkward://component/<href>.

i18n

Either a character string or a named list with the optional elements context or comment, to give some i18n_context information for this node.

Value

An object of class XiMpLe.node.

See Also

rk.rkh.doc and the Introduction to Writing Plugins for RKWard

Examples

package.link <- rk.rkh.link("Spice")
cat(pasteXML(package.link))

rkward-community/rkwarddev documentation built on May 9, 2022, 3:02 p.m.