chkHPD: Verify the Integrity of a Hive Plot Data Object

Description Usage Arguments Value Author(s) See Also Examples

View source: R/chkHPD.R

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

1
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

See Also

sumHPD which allows inspection (checking) of many properties of your HPD.

Examples

1
2
3
4
5
6
7
8
9
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 documentation built on July 1, 2020, 7:04 p.m.