rk.XML.dependency_check: Create XML node "dependency_check" for RKWard pluginmaps

View source: R/rk.XML.dependency_check.R

rk.XML.dependency_checkR Documentation

Create XML node "dependency_check" for RKWard pluginmaps

Description

Create XML node "dependency_check" for RKWard pluginmaps

Usage

rk.XML.dependency_check(
  id.name,
  dependencies = NULL,
  package = NULL,
  pluginmap = NULL,
  hints = FALSE
)

Arguments

id.name

Character string, a unique ID for this plugin element.

dependencies

A named list with these elements:

rkward.min

Minimum RKWard version needed for this plugin (optional)

rkward.max

Maximum RKWard version needed for this plugin (optional)

R.min

Minimum R version needed for this plugin (optional)

R.max

Maximum R version needed for this plugin (optional)

package

A list of named character vectors, each with these elements:

name

Name of a package this plugin depends on (optional)

min

Minimum version of the package (optional)

max

Maximum version of the package (optional)

repository

Repository to download the package (optional)

pluginmap

A named list with these elements:

name

Identifier of a pluginmap this plugin depends on (optional)

url

URL to get the pluginmap (optional)

hints

Logical, if TRUE, NULL values will be replaced with example text.

Note

The <dependency_check> node was introduced with RKWard 0.6.1, please set the dependencies of your component/plugin accordingly.

See Also

rk.XML.dependencies, and the Introduction to Writing Plugins for RKWard

Examples

dependency_check.node <- rk.XML.dependency_check(
  id.name="dep_check",
  dependencies=list(
    rkward.min="0.5.3",
    rkward.max="",
    R.min="2.10",
    R.max=""),
  package=list(
    c(name="heisenberg", min="0.11-2", max="",
      repository="http://rforge.r-project.org"),
    c(name="DreamsOfPi", min="0.2", max="", repository="")),
  pluginmap=list(
    c(name="heisenberg.pluginmap", url="http://eternalwondermaths.example.org/hsb"))
)

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