diff --git a/R/make.R b/R/make.R index 9a3f3307ce6..04748788a43 100644 --- a/R/make.R +++ b/R/make.R @@ -790,8 +790,6 @@ graph.atlas <- function(n) { # nocov start #' #' @param ... Parameters, see details below. #' -#' @seealso simplified with_edge_ with_graph_ with_vertex_ -#' without_loops without_multiples #' @export #' @examples #' r <- make_(ring(10)) @@ -803,6 +801,8 @@ graph.atlas <- function(n) { # nocov start #' ran <- sample_(degseq(c(3, 3, 3, 3, 3, 3), method = "configuration"), simplified()) #' degree(ran) #' is_simple(ran) +#' @family deterministic constructors +#' @family constructor modifiers make_ <- function(...) { me <- attr(sys.function(), "name") %||% "construct" extracted <- .extract_constructor_and_modifiers(..., .operation = me, .variant = "make") diff --git a/man/graph_from_atlas.Rd b/man/graph_from_atlas.Rd index 1a27f6fce15..f54d1fc6466 100644 --- a/man/graph_from_atlas.Rd +++ b/man/graph_from_atlas.Rd @@ -42,6 +42,7 @@ graph_from_atlas(sample(0:1252, 1)) Other deterministic constructors: \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/graph_from_edgelist.Rd b/man/graph_from_edgelist.Rd index 122ba54251e..cd5e81faae4 100644 --- a/man/graph_from_edgelist.Rd +++ b/man/graph_from_edgelist.Rd @@ -38,6 +38,7 @@ graph_from_edgelist(cbind(1:10, c(2:10, 1))) Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/graph_from_literal.Rd b/man/graph_from_literal.Rd index fe0cdcedd20..191735aed37 100644 --- a/man/graph_from_literal.Rd +++ b/man/graph_from_literal.Rd @@ -129,6 +129,7 @@ g6 Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/make_.Rd b/man/make_.Rd index 4d6f521b877..c97da16ff7b 100644 --- a/man/make_.Rd +++ b/man/make_.Rd @@ -42,6 +42,28 @@ degree(ran) is_simple(ran) } \seealso{ -simplified with_edge_ with_graph_ with_vertex_ -without_loops without_multiples +Other deterministic constructors: +\code{\link{graph_from_atlas}()}, +\code{\link{graph_from_edgelist}()}, +\code{\link{graph_from_literal}()}, +\code{\link{make_chordal_ring}()}, +\code{\link{make_empty_graph}()}, +\code{\link{make_full_citation_graph}()}, +\code{\link{make_full_graph}()}, +\code{\link{make_graph}()}, +\code{\link{make_lattice}()}, +\code{\link{make_ring}()}, +\code{\link{make_star}()}, +\code{\link{make_tree}()} + +Constructor modifiers (and related functions) +\code{\link{simplified}()}, +\code{\link{with_edge_}()}, +\code{\link{with_graph_}()}, +\code{\link{with_vertex_}()}, +\code{\link{without_attr}()}, +\code{\link{without_loops}()}, +\code{\link{without_multiples}()} } +\concept{constructor modifiers} +\concept{deterministic constructors} diff --git a/man/make_chordal_ring.Rd b/man/make_chordal_ring.Rd index 16f376d87a4..2b4127f4d01 100644 --- a/man/make_chordal_ring.Rd +++ b/man/make_chordal_ring.Rd @@ -46,6 +46,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, \code{\link{make_full_graph}()}, diff --git a/man/make_empty_graph.Rd b/man/make_empty_graph.Rd index 9bea1d081cf..21f96bc1d6e 100644 --- a/man/make_empty_graph.Rd +++ b/man/make_empty_graph.Rd @@ -31,6 +31,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_full_citation_graph}()}, \code{\link{make_full_graph}()}, diff --git a/man/make_full_citation_graph.Rd b/man/make_full_citation_graph.Rd index 908b894b3da..1b71a67b0ee 100644 --- a/man/make_full_citation_graph.Rd +++ b/man/make_full_citation_graph.Rd @@ -32,6 +32,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_graph}()}, diff --git a/man/make_full_graph.Rd b/man/make_full_graph.Rd index 5c4c8cc1115..be28e7efc5b 100644 --- a/man/make_full_graph.Rd +++ b/man/make_full_graph.Rd @@ -33,6 +33,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/make_graph.Rd b/man/make_graph.Rd index a69a75719a3..9f3d2b340eb 100644 --- a/man/make_graph.Rd +++ b/man/make_graph.Rd @@ -197,6 +197,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/make_lattice.Rd b/man/make_lattice.Rd index c31b03d8b91..d9a6bcc8917 100644 --- a/man/make_lattice.Rd +++ b/man/make_lattice.Rd @@ -62,6 +62,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/make_ring.Rd b/man/make_ring.Rd index f908a973ab8..25cadf9e45a 100644 --- a/man/make_ring.Rd +++ b/man/make_ring.Rd @@ -39,6 +39,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/make_star.Rd b/man/make_star.Rd index ad30b9ae416..59dd345bedb 100644 --- a/man/make_star.Rd +++ b/man/make_star.Rd @@ -38,6 +38,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/make_tree.Rd b/man/make_tree.Rd index fcad5310c51..42446786e14 100644 --- a/man/make_tree.Rd +++ b/man/make_tree.Rd @@ -39,6 +39,7 @@ Other deterministic constructors: \code{\link{graph_from_atlas}()}, \code{\link{graph_from_edgelist}()}, \code{\link{graph_from_literal}()}, +\code{\link{make_}()}, \code{\link{make_chordal_ring}()}, \code{\link{make_empty_graph}()}, \code{\link{make_full_citation_graph}()}, diff --git a/man/roxygen/meta.R b/man/roxygen/meta.R index 6faddc1d869..fa637ea9725 100644 --- a/man/roxygen/meta.R +++ b/man/roxygen/meta.R @@ -12,6 +12,7 @@ list( foreign = "Foreign format readers", games = "Random graph models (games)", scg = "Spectral Coarse Graining", - sgm = "Graph matching" + sgm = "Graph matching", + `constructor modifiers` = "Constructor modifiers (and related functions)" ) ) diff --git a/man/simplified.Rd b/man/simplified.Rd index 6a54cdf4fca..6766f9a3caa 100644 --- a/man/simplified.Rd +++ b/man/simplified.Rd @@ -14,7 +14,8 @@ sample_(pa(10, m = 3, algorithm = "bag")) sample_(pa(10, m = 3, algorithm = "bag"), simplified()) } \seealso{ -Other constructor modifiers: +Constructor modifiers (and related functions) +\code{\link{make_}()}, \code{\link{with_edge_}()}, \code{\link{with_graph_}()}, \code{\link{with_vertex_}()}, diff --git a/man/with_edge_.Rd b/man/with_edge_.Rd index 57cf8897428..6efc361ddde 100644 --- a/man/with_edge_.Rd +++ b/man/with_edge_.Rd @@ -23,7 +23,8 @@ make_( plot() } \seealso{ -Other constructor modifiers: +Constructor modifiers (and related functions) +\code{\link{make_}()}, \code{\link{simplified}()}, \code{\link{with_graph_}()}, \code{\link{with_vertex_}()}, diff --git a/man/with_graph_.Rd b/man/with_graph_.Rd index f44aef642b3..80fca7880d4 100644 --- a/man/with_graph_.Rd +++ b/man/with_graph_.Rd @@ -16,7 +16,8 @@ Constructor modifier to add graph attributes make_(ring(10), with_graph_(name = "10-ring")) } \seealso{ -Other constructor modifiers: +Constructor modifiers (and related functions) +\code{\link{make_}()}, \code{\link{simplified}()}, \code{\link{with_edge_}()}, \code{\link{with_vertex_}()}, diff --git a/man/with_vertex_.Rd b/man/with_vertex_.Rd index 2f053a6f55d..40b3bcd8f5e 100644 --- a/man/with_vertex_.Rd +++ b/man/with_vertex_.Rd @@ -24,7 +24,8 @@ make_( plot() } \seealso{ -Other constructor modifiers: +Constructor modifiers (and related functions) +\code{\link{make_}()}, \code{\link{simplified}()}, \code{\link{with_edge_}()}, \code{\link{with_graph_}()}, diff --git a/man/without_attr.Rd b/man/without_attr.Rd index 418bc1c7e6a..5c70ffa76d0 100644 --- a/man/without_attr.Rd +++ b/man/without_attr.Rd @@ -17,7 +17,8 @@ g2 <- make_(ring(10), without_attr()) g2 } \seealso{ -Other constructor modifiers: +Constructor modifiers (and related functions) +\code{\link{make_}()}, \code{\link{simplified}()}, \code{\link{with_edge_}()}, \code{\link{with_graph_}()}, diff --git a/man/without_loops.Rd b/man/without_loops.Rd index 778cf76d318..e955d24553f 100644 --- a/man/without_loops.Rd +++ b/man/without_loops.Rd @@ -15,7 +15,8 @@ make_(full_graph(5, loops = TRUE)) make_(full_graph(5, loops = TRUE), without_loops()) } \seealso{ -Other constructor modifiers: +Constructor modifiers (and related functions) +\code{\link{make_}()}, \code{\link{simplified}()}, \code{\link{with_edge_}()}, \code{\link{with_graph_}()}, diff --git a/man/without_multiples.Rd b/man/without_multiples.Rd index 8f35859255e..ea76edbf874 100644 --- a/man/without_multiples.Rd +++ b/man/without_multiples.Rd @@ -14,7 +14,8 @@ sample_(pa(10, m = 3, algorithm = "bag")) sample_(pa(10, m = 3, algorithm = "bag"), without_multiples()) } \seealso{ -Other constructor modifiers: +Constructor modifiers (and related functions) +\code{\link{make_}()}, \code{\link{simplified}()}, \code{\link{with_edge_}()}, \code{\link{with_graph_}()},