Add family tag to volcano docs

- added a `@family` tag to the docs
SomaLogic · Sep 20, 2023 · e739c4b · e739c4b
1 parent 937b888
commit e739c4b
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git 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
@@ -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
diff --git a/man/plotVolcanoHTML.Rd b/man/plotVolcanoHTML.Rd