ruleDist: Rule distance

View source: R/ruleDist.R

ruleDistR Documentation

Rule distance

Description

Calculate pairwise distance among a set of rules or between two sets of rules, where each rule defines a subpopulation

Usage

ruleDist(
  x,
  rules1,
  rules2 = NULL,
  print.plot = TRUE,
  plot.type = c("static", "interactive"),
  heat.lo = "black",
  heat.mid = NA,
  heat.hi = "#F48024",
  verbose = TRUE
)

Arguments

x

Data frame / matrix: Input features (cases by features)

rules1

Character, vector: Rules as combination of conditions on the features of x

rules2

String, vector, Optional: Rules as combination of conditions on the features of x

print.plot

Logical: If TRUE, plot heatmap for calculated distance

plot.type

Character: "static", "interactive": type of graphics to use, base or plotly, respectively. Default = "static"

heat.lo

Color: Heatmap low color. Default = "black"

heat.mid

Color: Heatmap mid color. Default = NA (i.e. create gradient from heat.lo to heat.hi)

heat.hi

Colo: Heatmap hi colo. Default = "#F48024" (orange)

verbose

Logical: If TRUE, print console messages. Default = TRUE

Details

If only rules1 is provided, computes pairwise distance among rules1, otherwise computes pairwise distance between rules1 and rules2

Author(s)

E.D. Gennatas


egenn/rtemis documentation built on May 4, 2024, 7:40 p.m.