From 9d3edf2bde8e74774b552c4623d62083b074df73 Mon Sep 17 00:00:00 2001
From: thpralas <theotime.pralas@centrale-med.fr>
Date: Thu, 30 May 2024 10:46:52 +0300
Subject: [PATCH] add minimum documentation for plotNMDS

---
 R/plotNDMS.R    | 10 ++++++++++
 man/plotNMDS.Rd | 16 ++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 man/plotNMDS.Rd

diff --git a/R/plotNDMS.R b/R/plotNDMS.R
index 253799c6..cdb18198 100644
--- 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
new file mode 100644
index 00000000..f1da75c2
--- /dev/null
+++ b/man/plotNMDS.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotNDMS.R
+\name{plotNMDS}
+\alias{plotNMDS}
+\title{Wrapper for scater::plotReducedDim()}
+\usage{
+plotNMDS(x, ..., ncomponents = 2)
+}
+\arguments{
+\item{x}{a
+\code{\link[SummarizedExperiment:SummarizedExperiment-class]{SummarizedExperiment}}
+object.}
+}
+\description{
+Wrapper for scater::plotReducedDim()
+}