From e739c4b4ec01db7249eb00b726869b395285aa9f Mon Sep 17 00:00:00 2001
From: Stu Field <stu.g.field@gmail.com>
Date: Tue, 19 Sep 2023 18:36:18 -0600
Subject: [PATCH] Add family tag to volcano docs

- added a `@family` tag to the docs
---
 R/plotVolcano.R        | 1 +
 R/plotVolcanoHTML.R    | 1 +
 man/plotVolcano.Rd     | 4 ++++
 man/plotVolcanoHTML.Rd | 4 ++++
 4 files changed, 10 insertions(+)

diff --git a/R/plotVolcano.R b/R/plotVolcano.R
index 76e816b..bcce87a 100644
--- a/R/plotVolcano.R
+++ b/R/plotVolcano.R
@@ -3,6 +3,7 @@
 #' Create a volcano plot given a vector of log2-transformed
 #' fold-changes (`FC`) and linear space p-values.
 #'
+#' @family volcano
 #' @inheritParams boxplotBeeswarm
 #' @param data A `data.frame` object containing at _least_ two columns
 #'   containing 1) log2-transformed fold-changes, 2) linear-space p-values.
diff --git a/R/plotVolcanoHTML.R b/R/plotVolcanoHTML.R
index fec549b..fd5a4cc 100644
--- a/R/plotVolcanoHTML.R
+++ b/R/plotVolcanoHTML.R
@@ -1,5 +1,6 @@
 #' Generate HTML-based Volcano Plot
 #'
+#' @family volcano
 #' @inheritParams boxplotBeeswarm
 #' @inheritParams plotVolcano
 #' @param data A data frame containing log2-transformed fold-changes and
diff --git a/man/plotVolcano.Rd b/man/plotVolcano.Rd
index b89fb28..9cd6a1d 100644
--- a/man/plotVolcano.Rd
+++ b/man/plotVolcano.Rd
@@ -78,7 +78,11 @@ plotVolcano(df, fc, p, labels = pt_label, identify = TRUE, cutoff = 0.01)
 }
 \seealso{
 \code{\link[=geom_point]{geom_point()}}.
+
+Other volcano: 
+\code{\link{plotVolcanoHTML}()}
 }
 \author{
 Stu Field
 }
+\concept{volcano}
diff --git a/man/plotVolcanoHTML.Rd b/man/plotVolcanoHTML.Rd
index dd2e0b3..4c73661 100644
--- a/man/plotVolcanoHTML.Rd
+++ b/man/plotVolcanoHTML.Rd
@@ -106,7 +106,11 @@ plotVolcanoHTML(df, log2_fc, p_value, cutoff = 0.1, fc.cutoff = 0.5, labels = ta
 }
 \seealso{
 \code{\link[plotly:plotly]{plotly::plotly()}}
+
+Other volcano: 
+\code{\link{plotVolcano}()}
 }
 \author{
 Leigh Alexander, Stu Field
 }
+\concept{volcano}