diff --git a/R/structural.properties.R b/R/structural.properties.R index 14765f8e5f..5a22305da3 100644 --- a/R/structural.properties.R +++ b/R/structural.properties.R @@ -2304,9 +2304,13 @@ bfs <- function( #' @examples #' #' ## A graph with two separate trees -#' dfs(make_tree(10) %du% make_tree(10), -#' root = 1, "out", -#' TRUE, TRUE, TRUE, TRUE +#' dfs( +#' graph = make_tree(10) %du% make_tree(10), +#' root = 1, mode = "out", +#' unreachable = TRUE, +#' order = TRUE, +#' order.out = TRUE, +#' parent = TRUE #' ) #' #' ## How to use a callback @@ -2318,8 +2322,9 @@ bfs <- function( #' cat("out:", paste(collapse = ", ", data), "\n") #' FALSE #' } -#' tmp <- dfs(make_tree(10), -#' root = 1, "out", +#' tmp <- dfs( +#' graph = make_tree(10), +#' root = 1, mode = "out", #' in.callback = f.in, out.callback = f.out #' ) #' @@ -2327,7 +2332,8 @@ bfs <- function( #' f.out <- function(graph, data, extra) { #' data["vid"] == 1 #' } -#' tmp <- dfs(make_tree(10) %du% make_tree(10), +#' tmp <- dfs( +#' graph = make_tree(10) %du% make_tree(10), #' root = 1, #' out.callback = f.out #' ) diff --git a/man/dfs.Rd b/man/dfs.Rd index bf560f4000..9b01309682 100644 --- a/man/dfs.Rd +++ b/man/dfs.Rd @@ -100,9 +100,13 @@ to terminate it. See examples below on how to use the callback functions. \examples{ ## A graph with two separate trees -dfs(make_tree(10) \%du\% make_tree(10), - root = 1, "out", - TRUE, TRUE, TRUE, TRUE +dfs( + graph = make_tree(10) \%du\% make_tree(10), + root = 1, mode = "out", + unreachable = TRUE, + order = TRUE, + order.out = TRUE, + parent = TRUE ) ## How to use a callback @@ -114,8 +118,9 @@ f.out <- function(graph, data, extra) { cat("out:", paste(collapse = ", ", data), "\n") FALSE } -tmp <- dfs(make_tree(10), - root = 1, "out", +tmp <- dfs( + graph = make_tree(10), + root = 1, mode = "out", in.callback = f.in, out.callback = f.out ) @@ -123,7 +128,8 @@ tmp <- dfs(make_tree(10), f.out <- function(graph, data, extra) { data["vid"] == 1 } -tmp <- dfs(make_tree(10) \%du\% make_tree(10), +tmp <- dfs( + graph = make_tree(10) \%du\% make_tree(10), root = 1, out.callback = f.out )