diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/networkplot.Rd | 28 | ||||
| -rw-r--r-- | man/saveplot.Rd | 34 |
2 files changed, 28 insertions, 34 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') + +} diff --git a/man/saveplot.Rd b/man/saveplot.Rd deleted file mode 100644 index 170e077..0000000 --- a/man/saveplot.Rd +++ /dev/null @@ -1,34 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/saveplot.R -\name{saveplot} -\alias{saveplot} -\title{Save a ggplot object} -\usage{ -saveplot(p, filename, units = "in", width = 10, height = 10, dpi = 600) -} -\arguments{ -\item{p}{ggplot object you want to save} - -\item{filename}{The name of the file you want to export to} - -\item{units}{The units for dimensions of the plot (default inches)} - -\item{width}{Width of the plot in units (default 10)} - -\item{height}{Height of the plot in units (default 10)} - -\item{dpi}{Dots per inch (detault 300)} -} -\value{ -No return value -} -\description{ -Standard method for saving ggplot objects for best -quality for the desired use case -} -\examples{ -df <- data.frame(x = rnorm(100)) -p <- ggplot2::ggplot(data = df, ggplot2::aes(x = x)) + ggplot2::geom_histogram() -saveplot(p, filename = 'plot.png') - -} |
