Add ordering function

1 files changed, 26 insertions, 0 deletions

diff --git a/man/get_order.Rd b/man/get_order.Rd
new file mode 100644
index 0000000..cbf0f38
--- /dev/null
+++ b/man/get_order.Rd
@@ -0,0 +1,26 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/get_order.R
+\name{get_order}
+\alias{get_order}
+\title{Identify Order}
+\usage{
+get_order(R, method = "hclust")
+}
+\arguments{
+\item{R}{A square numeric correlation matrix}
+
+\item{method}{Hierarchical method to perform (default hclust)}
+}
+\value{
+A character vector
+}
+\description{
+Perform clustering to identify the most useful ordering
+to analyze a heatmap or networkplot.
+}
+\examples{
+X <- matrix(data = rnorm(100), nrow = 10)
+R <- cor(X)
+get_order(R)
+
+}