feat: added proper support for adding attributes via data.frames (#1716)

Author: schochastics

R/attributes.R

@@ -349,6 +349,9 @@ graph.attributes <- function(graph) {
 "graph.attributes<-" <- function(graph, value) {
   ensure_igraph(graph)
   assert_named_list(value)
+  if (inherits(value, "data.frame")) {
+    value <- as.list(value)
+  }
 
   .Call(R_igraph_mybracket2_set, graph, igraph_t_idx_attr, igraph_attr_idx_graph, value)
 }
@@ -487,12 +490,8 @@ i_set_vertex_attr <- function(graph, name, index = V(graph), value, check = TRUE
     } else if (length(value) == length(index)) {
       value_in <- unname(value)
     } else {
-      stop(
-        "Length of new attribute value must be ",
-        if (length(index) != 1) "1 or ",
-        length(index),
-        ", the number of target vertices, not ",
-        length(value)
+      cli::cli_abort(
+        "Length of new attribute value must be {if (length(index) != 1) '1 or '}{length(index)}, the number of target vertices, not {length(value)}."
       )
     }
 
@@ -541,16 +540,19 @@ set_value_at <- function(value, idx, length_out) {
   ensure_igraph(graph)
 
   assert_named_list(value)
+  if (inherits(value, "data.frame")) {
+    value <- as.list(value)
+  }
 
   if (!all(lengths(value) == length(index))) {
-    stop("Invalid attribute value length, must match number of vertices")
+    cli::cli_abort("Invalid attribute value length, must match number of vertices.")
   }
 
   if (!missing(index)) {
     index <- as_igraph_vs(graph, index)
 
     if (anyDuplicated(index) || anyNA(index)) {
-      stop("Invalid vertices in index")
+      cli::cli_abort("{.arg index} contains duplicated vertices or NAs.")
     }
   }
 
@@ -698,12 +700,8 @@ i_set_edge_attr <- function(graph, name, index = E(graph), value, check = TRUE)
     } else if (length(value) == length(index)) {
       value_in <- unname(value)
     } else {
-      stop(
-        "Length of new attribute value must be ",
-        if (length(index) != 1) "1 or ",
-        length(index),
-        ", the number of target edges, not ",
-        length(value)
+      cli::cli_abort(
+        "Length of new attribute value must be {if (length(index) != 1) '1 or '}{length(index)}, the number of target edges, not {length(value)}."
       )
     }
 
@@ -741,15 +739,18 @@ edge.attributes <- function(graph, index = E(graph)) {
   ensure_igraph(graph)
 
   assert_named_list(value)
+  if (inherits(value, "data.frame")) {
+    value <- as.list(value)
+  }
 
   if (any(sapply(value, length) != length(index))) {
-    stop("Invalid attribute value length, must match number of edges")
+    cli::cli_abort("Invalid attribute value length, must match number of edges")
   }
 
   if (!missing(index)) {
     index <- as_igraph_es(graph, index)
     if (any(duplicated(index)) || any(is.na(index))) {
-      stop("Invalid edges in index")
+      cli::cli_abort("{.arg index} contains duplicated edges or NAs.")
     }
   }
 
@@ -855,7 +856,7 @@ delete_graph_attr <- function(graph, name) {
 
   name <- as.character(name)
   if (!name %in% graph_attr_names(graph)) {
-    stop("No such graph attribute: ", name)
+    cli::cli_abort("No graph attribute {.arg {name}} found.")
   }
 
   gattr <- .Call(R_igraph_mybracket2, graph, igraph_t_idx_attr, igraph_attr_idx_graph)
@@ -884,7 +885,7 @@ delete_vertex_attr <- function(graph, name) {
 
   name <- as.character(name)
   if (!name %in% vertex_attr_names(graph)) {
-    stop("No such vertex attribute: ", name)
+    cli::cli_abort("No vertex attribute {.arg {name}} found.")
   }
 
   vattr <- .Call(R_igraph_mybracket2, graph, igraph_t_idx_attr, igraph_attr_idx_vertex)
@@ -913,7 +914,7 @@ delete_edge_attr <- function(graph, name) {
 
   name <- as.character(name)
   if (!name %in% edge_attr_names(graph)) {
-    stop("No such edge attribute: ", name)
+    cli::cli_abort("No edge attribute {.arg {name}} found.")
   }
 
   eattr <- .Call(R_igraph_mybracket2, graph, igraph_t_idx_attr, igraph_attr_idx_edge)
@@ -1020,7 +1021,7 @@ igraph.i.attribute.combination <- function(comb) {
   if (any(!sapply(comb, function(x) {
     is.function(x) || (is.character(x) && length(x) == 1)
   }))) {
-    stop("Attribute combination element must be a function or character scalar")
+    cli::cli_abort("Attribute combination element must be a function or character scalar.")
   }
   if (is.null(names(comb))) {
     names(comb) <- rep("", length(comb))
@@ -1041,7 +1042,7 @@ igraph.i.attribute.combination <- function(comb) {
       )
       x <- pmatch(tolower(x), known[, 1])
       if (is.na(x)) {
-        stop("Unknown/unambigous attribute combination specification")
+        cli::cli_abort("Unknown/unambigous attribute combination specification.")
       }
       known[, 2][x]
     }
@@ -1185,17 +1186,15 @@ NULL
 }
 
 assert_named_list <- function(value) {
-  error_msg <- "{.arg value} must be a named list with unique names"
-
   if (!is.list(value)) {
-    rlang::abort(error_msg)
+    cli::cli_abort("{.arg value} must be a named list with unique names")
   }
 
   if (length(value) == 0) {
     return()
   }
 
   if (!rlang::is_named(value) || anyDuplicated(names(value)) > 0) {
-    rlang::abort(error_msg)
+    cli::cli_abort("{.arg value} must be a named list with unique names")
   }
 }

tests/testthat/_snaps/attributes.md

@@ -0,0 +1,56 @@
+# error messages work
+
+    Code
+      set_vertex_attr(g, "test", value = c(1, 2))
+    Condition
+      Error in `i_set_vertex_attr()`:
+      ! Length of new attribute value must be 1 or 5, the number of target vertices, not 2.
+
+---
+
+    Code
+      set_edge_attr(g, "test", value = c(1, 2))
+    Condition
+      Error in `i_set_edge_attr()`:
+      ! Length of new attribute value must be 1 or 10, the number of target edges, not 2.
+
+---
+
+    Code
+      delete_graph_attr(g, "a")
+    Condition
+      Error in `delete_graph_attr()`:
+      ! No graph attribute `a` found.
+
+---
+
+    Code
+      delete_vertex_attr(g, "a")
+    Condition
+      Error in `delete_vertex_attr()`:
+      ! No vertex attribute `a` found.
+
+---
+
+    Code
+      delete_edge_attr(g, "a")
+    Condition
+      Error in `delete_edge_attr()`:
+      ! No edge attribute `a` found.
+
+---
+
+    Code
+      assert_named_list("a")
+    Condition
+      Error in `assert_named_list()`:
+      ! `value` must be a named list with unique names
+
+---
+
+    Code
+      assert_named_list(list("a", "b"))
+    Condition
+      Error in `assert_named_list()`:
+      ! `value` must be a named list with unique names
+