Enhancement for #145. Doc Commit

fix(documentation): added the `plot.graph` parameter to `network()` documentation
mixOmicsTeam · Apr 3, 2022 · 8e09a5d · 8e09a5d
1 parent b62c53c
commit 8e09a5d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -63,5 +63,5 @@ biocViews: ImmunoOncology,
            MultipleComparison, 
            Classification, 
            Regression
-RoxygenNote: 7.1.1.9000
+RoxygenNote: 7.1.2
 Encoding: UTF-8
diff --git a/R/network.R b/R/network.R
@@ -136,6 +136,9 @@
 #' @param layout.fun a function. It specifies how the vertices will be placed
 #' on the graph. See help(layout) in the igraph package. Defaults to
 #' layout.fruchterman.reingold.
+#' @param plot.graph logical. If \code{TRUE} (default), plotting window will be 
+#' filled with network. If \code{FALSE}, then no graph will be plotted, though 
+#' the return value of the function is the exact same.
 #' @return \code{network} return a list containing the following components:
 #' \item{M}{the correlation matrix used by \code{network}.} \item{gR}{a
 #' \code{graph} object to save the graph for cytoscape use (requires to load

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