vegtable (version 0.1.7)

veg_relation: Retrieve or replace relations in vegtable objects

Description

Tables providing information about levels of categorical variables in the header of a Turboveg database are called popups in Turboveg, but relations in vegtable. Such variables will be converted into factors in the slot header according to the levels and their sorting in the respective relation.

Usage

veg_relation(vegtable, relation, ...)
# S4 method for vegtable,character
veg_relation(vegtable, relation, match_header = FALSE, ...)
veg_relation(vegtable, relation) <- value
# S4 method for vegtable,character,data.frame
veg_relation(vegtable, relation) <- value
relation2header(vegtable, relation, ...)
# S4 method for vegtable,data.frame
relation2header(vegtable, relation, by, vars, ...)
# S4 method for vegtable,character
relation2header(vegtable, relation, ...)

Value

This function retrieves and object of class data.frame. In the replacement method, an object of class vegtable, including value in the slot relations.

Arguments

vegtable

An object of class vegtable.

relation

A character value indicating the relation table to be retrieved or replaced.

...

Further arguments to be passed among methods.

match_header

A logical vector, whether only levels occurring in slot header should be considered or all.

value

A data frame containing the new veg_relation.

by

Character value indicating the name of the common column used as index for inserting values in slot header.

vars

A character vector with the names of variables to be inserted in slot header.

Author

Miguel Alvarez

Examples

## overview of references
veg_relation(Kenya_veg, "REFERENCE")