CreateCylinders: Create cylinders.

In mcavallaro/rancovr: Cluster detection in R with RAndom Neighbourhood COVeRing

Create cylinders.

Description

Create cylinders to cover events encoded in observation.matrix and evaluate their exceedances with respect to baseline. If observation.matrix and baseline have the same matrix dimension, the exceedances are computed calling compute. Otherwise the function this function assumes that the baseline is an expand.grid data.frame and exceedancies are computed with compute.from.tab.baseline.

Usage

CreateCylinders(
  observation.matrix,
  baseline,
  week.range,
  n.cylinders = 1000,
  p.val.threshold = 0.05,
  size_factor = 40,
  rho,
  coord.df = NULL,
  GT = 24,
  only.last = FALSE
)

Arguments

observation.matrix	A 2D Matrix or sparseMatrix object.
baseline	A 2D matrix or a Nx4 expand.grid data frame.
week.range	A numeric vector to set the lower and upper limit to the heigh of the cylinders.
n.cylinders	An integer, total number of drawn cylinders.
p.val.threshold	A numeric. If the probability of observed exceedance is < p.val.threshold, flag the cylinder as anomalous.
size_factor	A numeric multiplier to increase or reduce the cylinder heights and radia.

Examples

CreateCylinders(observation.matrix, baseline.matrix, week.range = c(0,99), n.cylinders = 10000)
CreateCylinders(observation.matrix, baseline.tab, week.range = c(0,99), n.cylinders = 100)

mcavallaro/rancovr documentation built on April 17, 2025, 7:21 p.m.