Fix #152

DESCRIPTION

@@ -19,6 +19,7 @@ Imports:
     cli,
     dplyr (>= 0.8.5),
     igraph (>= 1.3.0),
+    lifecycle,
     magrittr,
     pillar,
     R6,

NAMESPACE

@@ -315,6 +315,8 @@ export(play_fitness)
 export(play_fitness_power)
 export(play_forestfire)
 export(play_geometry)
+export(play_gnm)
+export(play_gnp)
 export(play_growing)
 export(play_islands)
 export(play_preference)
@@ -549,6 +551,7 @@ importFrom(igraph,vertex_connectivity)
 importFrom(igraph,which_loop)
 importFrom(igraph,which_multiple)
 importFrom(igraph,which_mutual)
+importFrom(lifecycle,deprecated)
 importFrom(magrittr,"%>%")
 importFrom(pillar,style_subtle)
 importFrom(pillar,tbl_format_footer)

NEWS.md

@@ -5,6 +5,8 @@
   the edges are encoded as a character (#147)
 * Added `node_is_connected()` to test whether a node is connected to a set of 
   nodes (#165)
+* Deprecated `play_erdos_renyi()` in favour of `play_gnm()` and `play_gnp()` 
+  (#152)
 
 # tidygraph 1.2.3
 

R/context.R

@@ -151,7 +151,7 @@ NULL
 #' @export
 #'
 #' @examples
-#' gr <- play_erdos_renyi(10, 0.3)
+#' gr <- play_gnp(10, 0.3)
 #'
 #' with_graph(gr, centrality_degree())
 #'

R/play.R

@@ -143,17 +143,19 @@ play_fitness <- function(m, out_fit, in_fit = NULL, loops = FALSE, multiple = FA
 play_fitness_power <- function(n, m, out_exp, in_exp = -1, loops = FALSE, multiple = FALSE, correct = TRUE) {
   as_tbl_graph(sample_fitness_pl(n, m, out_exp, in_exp, loops, multiple, correct))
 }
-#' @describeIn sampling_games Create graphs with a fixed edge probability or
-#' count. See [igraph::sample_gnp()] and [igraph::sample_gnm()]
-#' @importFrom igraph sample_gnm sample_gnp
+#' @describeIn sampling_games Create graphs with a fixed edge count. See
+#' [igraph::sample_gnm()]
+#' @importFrom igraph sample_gnm
 #' @export
-play_erdos_renyi <- function(n, p, m, directed = TRUE, loops = FALSE) {
-  if (missing(p)) {
-    as_tbl_graph(sample_gnm(n, m, directed, loops))
-  } else {
-    if (!missing(m)) cli::cli_warn('Ignoring {.arg m} as {.arg p} is provided')
-    as_tbl_graph(sample_gnp(n, p, directed, loops))
-  }
+play_gnm <- function(n, m, directed = TRUE, loops = FALSE) {
+  as_tbl_graph(sample_gnm(n, m, directed, loops))
+}
+#' @describeIn sampling_games Create graphs with a fixed edge probability. See
+#' [igraph::sample_gnp()]
+#' @importFrom igraph sample_gnp
+#' @export
+play_gnp <- function(n, p, directed = TRUE, loops = FALSE) {
+  as_tbl_graph(sample_gnp(n, p, directed, loops))
 }
 #' @describeIn sampling_games Create graphs by positioning nodes on a plane or
 #' torus and connecting nearby ones. See [igraph::sample_grg()]
@@ -162,6 +164,20 @@ play_erdos_renyi <- function(n, p, m, directed = TRUE, loops = FALSE) {
 play_geometry <- function(n, radius, torus = FALSE) {
   as_tbl_graph(sample_grg(n, radius, torus, TRUE))
 }
+#' @describeIn sampling_games `r lifecycle::badge('deprecated')` Create graphs
+#' with a fixed edge probability or count. See [igraph::sample_gnp()] and
+#' [igraph::sample_gnm()]
+#' @importFrom igraph sample_gnm sample_gnp
+#' @export
+play_erdos_renyi <- function(n, p, m, directed = TRUE, loops = FALSE) {
+  if (missing(p)) {
+    lifecycle::deprecate_soft("1.3.0", "play_erdos_renyi()", "play_gnm()")
+    as_tbl_graph(sample_gnm(n, m, directed, loops))
+  } else {
+    lifecycle::deprecate_soft("1.3.0", "play_erdos_renyi()", "play_gnp()")
+    as_tbl_graph(sample_gnp(n, p, directed, loops))
+  }
+}
 
 #' Graph games based on evolution
 #'

R/tidygraph-package.R

@@ -4,6 +4,7 @@
 # The following block is used by usethis to automatically manage
 # roxygen namespace tags. Modify with care!
 ## usethis namespace: start
+#' @importFrom lifecycle deprecated
 #' @useDynLib tidygraph, .registration = TRUE
 ## usethis namespace: end
 NULL