chmNewCovariate {NGCHM}R Documentation

Create a new Covariate for adding to an NGCHM auxilary dataset.

Description

This function creates a new Covariate suitable for a covariate bar or attaching to an NGCHM auxilary dataset.

Usage

chmNewCovariate(
  fullname,
  values,
  value.properties = NULL,
  type = NULL,
  covabbv = NULL
)

Arguments

fullname

The full (human readable) name of the covariate.

values

A named vector of values (character, logical, or numeric).

value.properties

An ngchmColormap mapping values to properties.

type

The string "discrete" or the string "continuous". (Defaults to continuous for numeric values, to discrete otherwise.)

covabbv

The short R-compatible identifier used to identify the covariate (derived from fullname if not specified).

Value

An object of class ngchmCovariate.

See Also

ngchmCovariate

chmAddCovariate()

chmNewColorMap()


[Package NGCHM version 1.0.3 Index]