HiveR: chkHPD – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

chkHPD

Verify the Integrity of a Hive Plot Data Object

Description

This function inspects the classes of each part of a HPD as a means of verifying its integrity. A few other characteristics are checked as well.

Usage

chkHPD(HPD, confirm = FALSE)

Arguments

`HPD`	An object of S3 class `HivePlotData`.
`confirm`	Logical; if `TRUE` then a favorable result is affirmed in the console (problems are always reported).

Value

A logical value; TRUE is there is a problem, otherwise FALSE.

Author(s)

Bryan A. Hanson, DePauw University. hanson@depauw.edu

Examples

test4 <- ranHiveData(nx = 4)
good <- chkHPD(test4, confirm = TRUE)
# mess it up and do again
# next test is not run as it halts execution
## Not run: 
test4$nodes$color <- as.factor(test4$nodes$color)
bad <- chkHPD(test4)

## End(Not run)

HiveR

2D and 3D Hive Plots for R

v0.3.63

GPL-3

Authors

Bryan A. Hanson [aut, cre] (<https://orcid.org/0000-0003-3536-8246>), Vesna Memisevic [ctb], Jonathan Chung [ctb]

Initial release

2020-06-08