Skip to content

Commit

Permalink
docs: split is_bipartite() manual page from other manual page (#1230)
Browse files Browse the repository at this point in the history
  • Loading branch information
aviator-app[bot] authored Feb 19, 2024
2 parents 681dcf3 + cde9af6 commit 247976e
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 21 deletions.
8 changes: 6 additions & 2 deletions R/attributes.R
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ is.named <- function(graph) { # nocov start
is_named(graph = graph)
} # nocov end

#' Create a bipartite graph
#' Checks whether the graph has a vertex attribute called `type`
#'
#' @description
#' `r lifecycle::badge("deprecated")`
Expand Down Expand Up @@ -1003,7 +1003,11 @@ is_weighted <- function(graph) {
"weight" %in% edge_attr_names(graph)
}

#' @rdname make_bipartite_graph
#' @title Checks whether the graph has a vertex attribute called `type`.
#' @description It does not check whether the graph is bipartite in the
#' mathematical sense. Use [bipartite_mapping()] for that.
#' @family bipartite
#' @param graph The input graph
#' @export
is_bipartite <- function(graph) {
ensure_igraph(graph)
Expand Down
4 changes: 0 additions & 4 deletions R/make.R
Original file line number Diff line number Diff line change
Expand Up @@ -1553,9 +1553,6 @@ full_bipartite_graph <- function(...) constructor_spec(make_full_bipartite_graph
#' vertex names; in this case, `types` must be a named vector that specifies
#' the type for each vertex name that occurs in `edges`.
#'
#' `is_bipartite()` checks whether the graph is bipartite or not. It just
#' checks whether the graph has a vertex attribute called `type`.
#'
#' @aliases graph.bipartite
#' @param types A vector giving the vertex types. It will be coerced into
#' boolean. The length of the vector gives the number of vertices in the graph.
Expand All @@ -1568,7 +1565,6 @@ full_bipartite_graph <- function(...) constructor_spec(make_full_bipartite_graph
#' @param directed Whether to create a directed graph, boolean constant. Note
#' that by default undirected graphs are created, as this is more common for
#' bipartite graphs.
#' @param graph The input graph.
#' @return `make_bipartite_graph()` returns a bipartite igraph graph. In other
#' words, an igraph graph that has a vertex attribute named `type`.
#'
Expand Down
3 changes: 2 additions & 1 deletion man/bipartite_mapping.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/bipartite_projection.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/is.bipartite.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions man/is_bipartite.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 4 additions & 11 deletions man/make_bipartite_graph.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 247976e

Please sign in to comment.