chore: add max_ivs() alias for maximal_ivs(), for consistency

.github/CONTRIBUTING.md

@@ -43,6 +43,10 @@ See the tidyverse guide on [how to create a great issue](https://code-review.tid
 
 *  We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. 
    Please add test cases for the change you are proposing, or ask us for help.
+
+### Naming conventions
+
+* Use `max` for maximal and `largest` for maximum.
 
 ### Test files
 

NAMESPACE

@@ -665,6 +665,7 @@ export(max_cliques)
 export(max_cohesion)
 export(max_degree)
 export(max_flow)
+export(max_ivs)
 export(maxcohesion)
 export(maximal.cliques)
 export(maximal.cliques.count)

R/cliques.R

@@ -4,14 +4,14 @@
 #' @description
 #' `r lifecycle::badge("deprecated")`
 #'
-#' `maximal.independent.vertex.sets()` was renamed to `maximal_ivs()` to create a more
+#' `maximal.independent.vertex.sets()` was renamed to `max_ivs()` to create a more
 #' consistent API.
-#' @inheritParams maximal_ivs
+#' @inheritParams max_ivs
 #' @keywords internal
 #' @export
 maximal.independent.vertex.sets <- function(graph) { # nocov start
-  lifecycle::deprecate_soft("2.0.0", "maximal.independent.vertex.sets()", "maximal_ivs()")
-  maximal_ivs(graph = graph)
+  lifecycle::deprecate_soft("2.0.0", "maximal.independent.vertex.sets()", "max_ivs()")
+  max_ivs(graph = graph)
 } # nocov end
 
 #' Functions to find cliques, i.e. complete subgraphs in a graph
@@ -382,7 +382,7 @@ weighted_clique_num <- weighted_clique_number_impl
 #' sets in the graph. An independent vertex set is largest if there is no
 #' independent vertex set with more vertices.
 #'
-#' `maximal_ivs()` finds the maximal independent vertex
+#' `max_ivs()` finds the maximal independent vertex
 #' sets in the graph. An independent vertex set is maximal if it cannot be
 #' extended to a larger independent vertex set. The largest independent vertex
 #' sets are maximal, but the opposite is not always true.
@@ -401,7 +401,7 @@ weighted_clique_num <- weighted_clique_number_impl
 #'   vertex sets to find. `NULL` means no limit.
 #' @return `ivs()`,
 #'   `largest_ivs()` and
-#'   `maximal_ivs()` return a list containing numeric
+#'   `max_ivs()` return a list containing numeric
 #'   vertex ids, each list element is an independent vertex set.
 #'
 #'   `ivs_size()` returns an integer constant.
@@ -428,7 +428,7 @@ weighted_clique_num <- weighted_clique_number_impl
 #' # Empty graph
 #' induced_subgraph(g, largest_ivs(g)[[1]])
 #'
-#' length(maximal_ivs(g))
+#' length(max_ivs(g))
 ivs <- function(graph, min = NULL, max = NULL) {
   ensure_igraph(graph)
 
@@ -472,7 +472,7 @@ largest_ivs <- function(graph) {
 
 #' @rdname ivs
 #' @export
-maximal_ivs <- function(graph) {
+max_ivs <- function(graph) {
   ensure_igraph(graph)
 
   on.exit(.Call(R_igraph_finalizer))
@@ -486,6 +486,21 @@ maximal_ivs <- function(graph) {
   res
 }
 
+#' Maximal independent vertex sets in the graph
+#'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `maximal_ivs()` was renamed to `max_ivs()` to create a more
+#' consistent API.
+#' @export
+#' @inheritParams max_ivs
+#' @keywords internal
+maximal_ivs <- function(graph) {
+  lifecycle::deprecate_soft("2.0.4", "maximal_ivs()", "max_ivs()")
+  max_ivs(graph)
+}
+
 #' @rdname ivs
 #' @export
 ivs_size <- function(graph) {

inst/lifecycle/deprecated.csv

@@ -186,7 +186,7 @@ list.vertex.attributes,<a href='https://r.igraph.org/reference/vertex_attr_names
 maxcohesion,<a href='https://r.igraph.org/reference/cohesive_blocks.html'>igraph::max_cohesion</a>
 maximal.cliques,<a href='https://r.igraph.org/reference/cliques.html'>igraph::max_cliques</a>
 maximal.cliques.count,<a href='https://r.igraph.org/reference/cliques.html'>igraph::count_max_cliques</a>
-maximal.independent.vertex.sets,<a href='https://r.igraph.org/reference/ivs.html'>igraph::maximal_ivs</a>
+maximal.independent.vertex.sets,<a href='https://r.igraph.org/reference/ivs.html'>igraph::max_ivs</a>
 minimal.st.separators,<a href='https://r.igraph.org/reference/min_st_separators.html'>igraph::min_st_separators</a>
 maximum.bipartite.matching,<a href='https://r.igraph.org/reference/matching.html'>igraph::max_bipartite_match</a>
 maximum.cardinality.search,<a href='https://r.igraph.org/reference/max_cardinality.html'>igraph::max_cardinality</a>