add minimum documentation for plotNMDS

microbiome · May 30, 2024 · 9d3edf2 · 9d3edf2
1 parent a18fc40
commit 9d3edf2
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/R/plotNDMS.R b/R/plotNDMS.R
@@ -1,3 +1,13 @@
+#' Wrapper for scater::plotReducedDim()
+#' 
+#' @param x a
+#'   \code{\link[SummarizedExperiment:SummarizedExperiment-class]{SummarizedExperiment}}
+#'   object.
+#'   
+#' @name plotNMDS
+NULL
+
+#' @rdname plotNMDS
 #' @export
 plotNMDS <- function(x, ..., ncomponents = 2){
     plotReducedDim(x, ncomponents = ncomponents, dimred = "NMDS", ...)

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