From 9589016016a25d7c110a76fb9690fc881effe9a8 Mon Sep 17 00:00:00 2001
From: "Martin R. Smith" <1695515+ms609@users.noreply.github.com>
Date: Fri, 23 Feb 2024 14:33:13 +0000
Subject: [PATCH] QuickRogue() return

Per #27
---
 DESCRIPTION      | 2 +-
 R/SPIC.R         | 2 ++
 man/RogueTaxa.Rd | 3 +++
 3 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 7610435..def2d22 100644
--- 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
index 6f13d7d..8bc7eec 100644
--- 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
index aa9e493..8c7bc71 100644
--- a/man/RogueTaxa.Rd
+++ b/man/RogueTaxa.Rd
@@ -128,6 +128,9 @@ Columns describe:
 by the measure indicated by \code{info}.
 }
 
+\code{QuickRogue()} returns a \code{data.frame} in the same format as
+\code{RogueTaxa()}.
+
 \code{C_RogueNaRok()} returns \code{0} if successful; \code{-1} on error.
 }
 \description{