Add examples to build and caugi_verbs documentation

Author: frederikfabriciusbjerre

R/verbs.R

@@ -18,6 +18,23 @@ build <- S7::new_generic("build", "cg")
 #'
 #' @returns The built `caugi_graph` object.
 #'
+#' @examples
+#' # initialize empty graph and build slowly
+#' cg <- caugi_graph(class = "PDAG")
+#'
+#' cg <- cg |>
+#'   add_nodes(c("A", "B", "C", "D", "E")) |> # A, B, C, D, E
+#'   add_edges(A %-->% B %-->% C) |> # A --> B --> C, D, E
+#'   set_edges(B %---% C) # A --> B --- C, D, E
+#'
+#' cg <- remove_edges(cg, B %---% C) |> # A --> B, C, D, E
+#'   remove_nodes(c("C", "D", "E")) # A --> B
+#'
+#' # verbs do not build the Rust backend
+#' cg@built # FALSE
+#' build(cg)
+#' cg@built # TRUE
+#'
 #' @family verbs
 #' @concept verbs
 #'
@@ -103,6 +120,23 @@ S7::method(build, caugi_graph) <- function(cg, ...) {
 #'
 #' @returns The updated `caugi_graph`.
 #'
+#' @examples
+#' # initialize empty graph and build slowly
+#' cg <- caugi_graph(class = "PDAG")
+#'
+#' cg <- cg |>
+#'   add_nodes(c("A", "B", "C", "D", "E")) |> # A, B, C, D, E
+#'   add_edges(A %-->% B %-->% C) |> # A --> B --> C, D, E
+#'   set_edges(B %---% C) # A --> B --- C, D, E
+#'
+#' cg <- remove_edges(cg, B %---% C) |> # A --> B, C, D, E
+#'   remove_nodes(c("C", "D", "E")) # A --> B
+#'
+#' # verbs do not build the Rust backend
+#' cg@built # FALSE
+#' build(cg)
+#' cg@built # TRUE
+#'
 #' @family verbs
 #' @concept verbs
 NULL