docs: replace instances of #' if with #' @examplesIf

[maelle]

Fix #1134

I'll run document() after #1696 is merged

[aviator-app]

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged manually (without Aviator). Merging manually can negatively impact the performance of the queue. Consider using Aviator next time.

---

See the real-time status of this PR on the Aviator webapp.

Use the Aviator Chrome Extension to see the status of your PR within GitHub.

[maelle]

Interesting failure

library("igraph")
#> 
#> Attaching package: 'igraph'
#> The following objects are masked from 'package:stats':
#> 
#>     decompose, spectrum
#> The following object is masked from 'package:base':
#> 
#>     union
C <- matrix(c(
  1, 3 / 4, 0,
  3 / 4, 0, 3 / 4,
  0, 3 / 4, 3 / 4
), nrow = 3)
g <- sample_hierarchical_sbm(100, 10, rho = c(3, 3, 4) / 10, C = C, p = 1 / 20)
g
#> IGRAPH e0a8c18 U--- 100 477 -- Hierarchical stochastic block model
#> + attr: name (g/c), m (g/n), rho (g/n), C (g/n), p (g/n)
#> + edges from e0a8c18:
#>  [1]  1-- 2  1-- 3  2-- 3  1-- 4  2-- 4  1-- 5  2-- 5  3-- 5  1-- 6  2-- 6
#> [11]  3-- 6  4-- 7  4-- 8  5-- 8  6-- 8  4-- 9  5-- 9  6-- 9  4--10  5--10
#> [21]  7-- 8  7-- 9  8-- 9  7--10  8--10 11--12 11--13 12--13 11--14 13--14
#> [31] 11--15 12--15 13--15 11--16 12--16 13--16 14--18 15--18 14--19 15--19
#> [41] 16--19 14--20 16--20 17--18 17--19 18--19 17--20 21--22 21--23 22--23
#> [51] 21--24 23--24 21--25 22--25 23--25 21--26 22--26 24--27 25--27 26--27
#> [61] 24--28 25--28 25--29 26--29 24--30 25--30 26--30 27--28 27--29 27--30
#> [71] 28--30 29--30 31--32 31--33 32--33 31--34 33--34 31--35 32--35 33--35
#> + ... omitted several edges


image(g[])
#> Error in image.default(g[]): 'z' must be a matrix

^{Created on 2025-02-19 with reprex v2.1.1}

[maelle]

load the package