docs: replace instances of #' if with #' @examplesIf (#1698)

igraph · Feb 20, 2025 · 22cd83e · 22cd83e
1 parent f7ab64d
commit 22cd83e
Show file tree

Hide file tree

Showing 112 changed files with 176 additions and 161 deletions.
diff --git a/R/centrality.R b/R/centrality.R
@@ -668,19 +668,26 @@ arpack_defaults <- function() {
 #'
 #' ## First three eigenvalues of the adjacency matrix of a graph
 #' ## We need the 'Matrix' package for this
-#' if (require(Matrix)) {
-#'   set.seed(42)
-#'   g <- sample_gnp(1000, 5 / 1000)
-#'   M <- as_adjacency_matrix(g, sparse = TRUE)
-#'   f2 <- function(x, extra = NULL) {
-#'     cat(".")
-#'     as.vector(M %*% x)
-#'   }
-#'   baev <- arpack(f2, sym = TRUE, options = list(
-#'     n = vcount(g), nev = 3, ncv = 8,
-#'     which = "LM", maxiter = 2000
-#'   ))
+#' @examplesIf rlang::is_installed("Matrix")
+#' library("Matrix")
+#' set.seed(42)
+#' g <- sample_gnp(1000, 5 / 1000)
+#' M <- as_adjacency_matrix(g, sparse = TRUE)
+#' f2 <- function(x, extra = NULL) {
+#'   cat(".")
+#'   as.vector(M %*% x)
 #' }
+#' baev <- arpack(
+#'   f2,
+#'   sym = TRUE,
+#'   options = list(
+#'     n = vcount(g),
+#'     nev = 3,
+#'     ncv = 8,
+#'     which = "LM",
+#'     maxiter = 2000
+#'   )
+#' )
 #' @family arpack
 #' @export
 arpack <- function(func, extra = NULL, sym = FALSE, options = arpack_defaults(),

diff --git a/R/demo.R b/R/demo.R
@@ -58,9 +58,9 @@ igraphdemo <- function(which) { # nocov start
 #' @examples
 #'
 #' igraph_demo()
-#' if (interactive() && requireNamespace("tcltk", quietly = TRUE)) {
-#'   igraph_demo("centrality")
-#' }
+#'
+#' @examplesIf interactive() && rlang::is_installed("tcltk")
+#' igraph_demo("centrality")
 #'
 igraph_demo <- function(which) {
   if (missing(which)) {

diff --git a/R/games.R b/R/games.R
@@ -1877,9 +1877,10 @@ sbm <- function(...) constructor_spec(sample_sbm, ...)
 #' ), nrow = 3)
 #' g <- sample_hierarchical_sbm(100, 10, rho = c(3, 3, 4) / 10, C = C, p = 1 / 20)
 #' g
-#' if (require(Matrix)) {
-#'   image(g[])
-#' }
+#'
+#' @examplesIf rlang::is_installed("Matrix")
+#' library("Matrix")
+#' image(g[])
 #' @family games
 #' @export
 #' @cdocs igraph_hsbm_game

diff --git a/R/plot.R b/R/plot.R
@@ -527,9 +527,9 @@ plot.igraph <- function(x,
 #'
 #' g <- make_lattice(c(5, 5, 5))
 #' coords <- layout_with_fr(g, dim = 3)
-#' if (interactive() && requireNamespace("rgl", quietly = TRUE)) {
-#'   rglplot(g, layout = coords)
-#' }
+#'
+#' @examplesIf interactive() && rlang::is_installed("rgl")
+#' rglplot(g, layout = coords)
 #'
 rglplot <- function(x, ...) {
   UseMethod("rglplot", x)

diff --git a/R/plot.common.R b/R/plot.common.R
@@ -1440,14 +1440,12 @@ i.default.values[["plot"]] <- i.plot.default
 #' @examples
 #'
 #' g <- make_ring(10)
-#' values <- lapply(1:10, function(x) sample(1:10, 3))
-#' if (interactive()) {
-#'   plot(g,
-#'     vertex.shape = "pie", vertex.pie = values,
-#'     vertex.pie.color = list(heat.colors(5)),
-#'     vertex.size = seq(10, 30, length.out = 10), vertex.label = NA
-#'   )
-#' }
+#' values <- lapply(1:10, function(x) sample(1:10,3))
+#'
+#' @examplesIf interactive()
+#' plot(g, vertex.shape = "pie", vertex.pie = values,
+#'      vertex.pie.color = list(heat.colors(5)),
+#'      vertex.size = seq(10, 30, length.out = 10), vertex.label = NA)
 #' @rdname vertex.shape.pie
 #' @name vertex.shape.pie
 NULL
diff --git a/man/are_adjacent.Rd b/man/are_adjacent.Rd
diff --git a/man/arpack.Rd b/man/arpack.Rd
diff --git a/man/articulation_points.Rd b/man/articulation_points.Rd
diff --git a/man/as_directed.Rd b/man/as_directed.Rd
diff --git a/man/assortativity.Rd b/man/assortativity.Rd
diff --git a/man/automorphism_group.Rd b/man/automorphism_group.Rd
diff --git a/man/biconnected_components.Rd b/man/biconnected_components.Rd
diff --git a/man/bipartite_mapping.Rd b/man/bipartite_mapping.Rd
diff --git a/man/bipartite_projection.Rd b/man/bipartite_projection.Rd
diff --git a/man/canonical_permutation.Rd b/man/canonical_permutation.Rd
diff --git a/man/centr_betw_tmax.Rd b/man/centr_betw_tmax.Rd
diff --git a/man/centr_clo.Rd b/man/centr_clo.Rd
diff --git a/man/centr_clo_tmax.Rd b/man/centr_clo_tmax.Rd
diff --git a/man/centr_degree.Rd b/man/centr_degree.Rd
diff --git a/man/centr_eigen.Rd b/man/centr_eigen.Rd
diff --git a/man/centr_eigen_tmax.Rd b/man/centr_eigen_tmax.Rd
diff --git a/man/centralize.Rd b/man/centralize.Rd
diff --git a/man/cliques.Rd b/man/cliques.Rd
diff --git a/man/components.Rd b/man/components.Rd
diff --git a/man/consensus_tree.Rd b/man/consensus_tree.Rd
diff --git a/man/contract.Rd b/man/contract.Rd
diff --git a/man/convex_hull.Rd b/man/convex_hull.Rd
diff --git a/man/count_automorphisms.Rd b/man/count_automorphisms.Rd
diff --git a/man/count_triangles.Rd b/man/count_triangles.Rd
diff --git a/man/degree.Rd b/man/degree.Rd
diff --git a/man/dim_select.Rd b/man/dim_select.Rd
diff --git a/man/distances.Rd b/man/distances.Rd
diff --git a/man/diversity.Rd b/man/diversity.Rd
diff --git a/man/dyad_census.Rd b/man/dyad_census.Rd
diff --git a/man/eccentricity.Rd b/man/eccentricity.Rd
diff --git a/man/edge_density.Rd b/man/edge_density.Rd