From 22dbbbfcc61ccd643deb4566c104d399ed6b7059 Mon Sep 17 00:00:00 2001 From: Max Bladen Date: Tue, 30 Aug 2022 12:37:29 +1000 Subject: [PATCH] Enhancement for Issue #233 docs: updated documentation for `network()` with new parameters --- R/network.R | 5 +++++ man/network.Rd | 11 ++++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/R/network.R b/R/network.R index 412a36bd..235314c0 100644 --- a/R/network.R +++ b/R/network.R @@ -96,6 +96,11 @@ #' threshold for the relevant associations network (see Details). #' @param row.names,col.names character vector containing the names of \eqn{X}- #' and \eqn{Y}-variables. +#' @param graph.scale Numeric between 0 and 1 which alters the scale of the entire +#' plot. Increasing the value decreases the size of nodes and increases their distance +#' from one another. Defaults to 0.5. +#' @param size.node Numeric between 0 and 1 which determines the relative size of nodes. +#' Defaults to 0.5. #' @param color.node vector of length two, the colors of the \eqn{X} and #' \eqn{Y} nodes (see Details). #' @param shape.node character vector of length two, the shape of the \eqn{X} diff --git a/man/network.Rd b/man/network.Rd index 9d4b1a7d..61eb04ab 100644 --- a/man/network.Rd +++ b/man/network.Rd @@ -16,10 +16,12 @@ network( row.names = TRUE, col.names = TRUE, block.var.names = TRUE, + graph.scale = 0.5, + size.node = 0.5, color.node = NULL, shape.node = NULL, alpha.node = 0.85, - cex.node.name = 1, + cex.node.name = NULL, color.edge = color.GreenRed(100), lty.edge = "solid", lwd.edge = 1, @@ -58,6 +60,13 @@ and \eqn{Y}-variables.} in each block or FALSE for no names. If TRUE, the columns names of the blocks are used as names.} +\item{graph.scale}{Numeric between 0 and 1 which alters the scale of the entire +plot. Increasing the value decreases the size of nodes and increases their distance +from one another. Defaults to 0.5.} + +\item{size.node}{Numeric between 0 and 1 which determines the relative size of nodes. +Defaults to 0.5.} + \item{color.node}{vector of length two, the colors of the \eqn{X} and \eqn{Y} nodes (see Details).}