Fix #296

R/create_edge_df.R

@@ -17,14 +17,14 @@
 #'
 #' An arbitrary number of additional columns containing aesthetic or data
 #' attributes can be part of the edf, so long as they follow the aforementioned
-#' columns.
+#' columns. Some examples are included in [edge_aes()]
 #'
 #' @param from A vector of node ID values from which edges are outbound. The
 #'   vector length must equal that of the `to` vector.
 #' @param to A vector of node ID values to which edges are incoming. The vector
 #'   length must equal that of the `from` vector.
 #' @param rel An optional `rel` label for each edge.
-#' @param ... One or more vectors for associated edge attributes.
+#' @param ... One or more vectors for associated edge attributes. Can be some of [edge_aes()]
 #'
 #' @return An edge data frame (edf).
 #'

R/create_node_df.R

@@ -14,14 +14,13 @@
 #' - `label` (of type `character`)
 #'
 #' An arbitrary number of additional columns containing aesthetic or data
-#' attributes can be part of the ndf, so long as they follow the aforementioned
+#' attributes can be part of the ndf, see [node_aes()] for additional attributes that can be used with ..., so long as they follow the aforementioned
 #' columns.
 #'
 #' @param n The total number of nodes to include in the node data frame.
 #' @param type An optional `type` for each node.
 #' @param label An optional `label` for each node.
-#' @param ... One or more vectors for associated node attributes.
-#'
+#' @param ... Additional attributes. Some are present in [node_aes()]
 #' @return A node data frame (ndf).
 #'
 #' @examples
@@ -67,7 +66,7 @@ create_node_df <- function(
 ) {
 
   check_number_whole(n)
-
+  # FIXME, nothing stopping ae
   type <- type %||% rep(NA_character_, n)
 
   # Expand vectors with single values to fill to

R/set_edge_attrs.R

@@ -6,7 +6,7 @@
 #' or more edges.
 #'
 #' @inheritParams render_graph
-#' @param edge_attr The name of the attribute to set.
+#' @param edge_attr The name of the attribute to set. Some examples are located in [edge_aes()]
 #' @param values The values to be set for the chosen attribute for the chosen
 #'   edges.
 #' @param from An optional vector of node IDs from which the edge is outgoing

R/set_node_attrs.R

@@ -6,7 +6,7 @@
 #' or more nodes.
 #'
 #' @inheritParams render_graph
-#' @param node_attr The name of the attribute to set.
+#' @param node_attr The name of the attribute to set. Examples of attributes can be found in [node_aes()].
 #' @param values The values to be set for the chosen attribute for the chosen
 #'   nodes.
 #' @param nodes An optional vector of node IDs for filtering the list of nodes