QuickRogue() return

Per #27
ms609 · Feb 23, 2024 · 9589016 · 9589016
1 parent 660deae
commit 9589016
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -59,5 +59,5 @@ ByteCompile: true
 Encoding: UTF-8
 Language: en-GB
 VignetteBuilder: knitr
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Roxygen: list(markdown = TRUE)
diff --git a/R/SPIC.R b/R/SPIC.R
@@ -5,6 +5,8 @@
 #' majority rule tree; 1.0 will maximize the information content of the
 #' strict consensus.
 #' @inheritParams TipInstability
+#' @returns `QuickRogue()` returns a `data.frame` in the same format as
+#' `RogueTaxa()`.
 #' @describeIn RogueTaxa Shortcut to "fast" heuristic, with option to return
 #' evaluation of all taxa using `fullSeq = TRUE`.
 #' @examples

diff --git a/man/RogueTaxa.Rd b/man/RogueTaxa.Rd