Create networkplot

1 files changed, 28 insertions, 0 deletions

diff --git a/man/networkplot.Rd b/man/networkplot.Rd
new file mode 100644
index 0000000..055bc46
--- /dev/null
+++ b/man/networkplot.Rd
@@ -0,0 +1,28 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/networkplot.R
+\name{networkplot}
+\alias{networkplot}
+\title{Network Plot}
+\usage{
+networkplot(R, title = NULL)
+}
+\arguments{
+\item{R}{A square numeric matrix with names columns and rows}
+
+\item{title}{Optional plot title}
+}
+\value{
+A ggraph object
+}
+\description{
+Draw an undirected graph from a square matrix
+where each variable is a node and the pairwise
+entries are the strength of the relationship
+(ex: correlation, partial correlation)
+}
+\examples{
+X <- matrix(data = rnorm(100), nrow = 10)
+R <- cor(X)
+networkplot(R, title = 'Example Correlation Plot')
+
+}