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

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

rk.XML.dependenciesR Documentation

Create XML node "dependencies" for RKWard pluginmaps

Description

Create XML node "dependencies" for RKWard pluginmaps

Usage

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

Arguments

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 (required)

min

Minimum version of the package (optional)

max

Maximum version of the package (optional)

repository

Repository to download the package (optional, recommended)

pluginmap

A named list with these elements:

name

Identifier of a pluginmap this plugin depends on (required)

min

Minimum version of the pluginmap (optional)

max

Maximum version of the pluginmap (optional)

url

URL to get the pluginmap (required)

hints

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

Note

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

See Also

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

Examples

dependencies.node <- rk.XML.dependencies(
  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.