This function tests to see whether an object is of class qm_cluster. It is used as part of the qm_combine and qm_summarize functions, and is exported so that it can be used interactively as well.

qm_is_cluster(obj)

Arguments

obj

Object to test

Value

A logical scalar that is TRUE is the given object is of class qm_cluster; it will return FALSE otherwise.

See also

qm_combine, qm_summarize

Examples

# load and format reference data stl <- stLouis stl <- dplyr::mutate(stl, TRACTCE = as.numeric(TRACTCE)) # create cluster cluster <- qm_define(118600, 119101, 119300) # create simple cluster object cluster_obj <- qm_create(ref = stl, key = TRACTCE, value = cluster, rid = 1, cid = 1, category = "positive") # test cluster object qm_is_cluster(cluster_obj)
#> [1] TRUE