Add function to list available edges (#256)

* Add function list_caugi_edges()

Author: BjarkeHautop

NAMESPACE

@@ -64,6 +64,7 @@ export(is_valid_adjustment_admg)
 export(is_valid_backdoor)
 export(latent_project)
 export(length)
+export(list_caugi_edges)
 export(m_separated)
 export(markov_blanket)
 export(meek_closure)

NEWS.md

@@ -1,5 +1,9 @@
 # caugi (development version)
 
+## New Features
+
+- Add `list_caugi_edges()` function to list all available edge types.
+
 ## Improvements
 
 - Improved performance of all queries. Speedups are more significant on larger graphs,

R/registry.R

@@ -29,6 +29,9 @@
 #' # create a new registry
 #' reg <- caugi_registry()
 #'
+#' # list registered edges
+#' list_caugi_edges()
+#'
 #' # register an edge
 #' register_caugi_edge(
 #'   glyph = "<--",
@@ -39,6 +42,7 @@
 #' )
 #'
 #' # now, this edge is available for caugi graphs:
+#' list_caugi_edges()
 #' cg <- caugi(A %-->% B, B %<--% C, class = "DAG")
 #'
 #' # reset the registry to default
@@ -65,6 +69,44 @@ caugi_registry <- function() {
   .caugi_env$reg
 }
 
+#' @describeIn registry List all registered edge types in the global registry.
+#'
+#' @returns A `data.table` with columns `glyph`, `tail`, `head`, `class`, and
+#' `symmetric`, where each row corresponds to a registered edge type.
+#'
+#' @export
+list_caugi_edges <- function() {
+  reg <- caugi_registry()
+  n <- edge_registry_len(reg)
+
+  empty_dt <- data.table::data.table(
+    glyph = character(),
+    tail = character(),
+    head = character(),
+    class = character(),
+    symmetric = logical()
+  )
+
+  if (n == 0) {
+    return(empty_dt)
+  }
+
+  dt <- data.table::rbindlist(
+    lapply(seq_len(n) - 1L, function(code) {
+      spec <- edge_registry_spec_of_code(reg, code)
+      data.table::data.table(
+        glyph = spec$glyph,
+        tail = spec$tail,
+        head = spec$head,
+        class = spec$class,
+        symmetric = spec$symmetric
+      )
+    })
+  )
+
+  dt
+}
+
 #' @describeIn registry Reset the global edge registry to its default state.
 #'
 #' @export

man/registry.Rd

@@ -82,6 +82,22 @@ test_that("glyph arbitary length works", {
   reset_caugi_registry()
 })
 
+# ──────────────────────────────────────────────────────────────────────────────
+# ───────────────────────────────── View edges ─────────────────────────────────
+# ──────────────────────────────────────────────────────────────────────────────
+
+test_that("View edges work with caugi_registry", {
+  reset_caugi_registry()
+  before_edges <- list_caugi_edges()
+  register_caugi_edge("<--", "arrow", "tail", "directed", FALSE)
+  after_edges <- list_caugi_edges()
+
+  expect_equal(nrow(after_edges), nrow(before_edges) + 1)
+  expect_true("<--" %in% after_edges$glyph)
+
+  reset_caugi_registry()
+})
+
 
 # ──────────────────────────────────────────────────────────────────────────────
 # ───────────────────────────────── Sealing ────────────────────────────────────