Skip to content

docs: add example for consensus_tree() (from fit_hrg() example) #1453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
maelle wants to merge 2 commits into
base: main
Choose a base branch
from
+17 −0
Draft

docs: add example for consensus_tree() (from fit_hrg() example) #1453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
779bf11
docs: add example for `consensus_tree()` (from `fit_hrg()` example)
maelle Aug 20, 2024
fc9dc8c
Merge branch 'main' into consensus-tree
krlmlr Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions R/hrg.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,14 @@ fit_hrg <- function(graph, hrg = NULL, start = FALSE, steps = 0) {
#' }
#' }
#' @family hierarchical random graph functions
#' @examples
#' ## A graph with two dense groups
#' g <- sample_gnp(10, p = 1 / 2) + sample_gnp(10, p = 1 / 2)
#' hrg <- fit_hrg(g)
#' hrg
#'
#' ## The consensus tree for it
#' consensus_tree(g, hrg = hrg, start = TRUE)
Comment on lines +306 to +313
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new example will run during non-interactive R CMD check and calls consensus_tree() with the default num.samples = 10000, which can be slow. Other HRG examples in this file are guarded with @examplesIf rlang::is_interactive() (e.g., the fit_hrg() / predict_edges() docs); consider switching this block to @examplesIf rlang::is_interactive() (or reducing num.samples) to keep checks fast and reliable.

Copilot uses AI. Check for mistakes.
#' @export
#' @cdocs igraph_hrg_consensus
consensus_tree <- function(
Expand Down
9 changes: 9 additions & 0 deletions man/consensus_tree.Rd
View file
Open in desktop

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

Loading