Add stability_score and signal to noise ratio plot functions

2 files changed, 41 insertions, 0 deletions

diff --git a/man/plot_snr.Rd b/man/plot_snr.Rd
new file mode 100644
index 0000000..177b6ed
--- /dev/null
+++ b/man/plot_snr.Rd
@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plot_snr.R
+\name{plot_snr}
+\alias{plot_snr}
+\title{Plot Signal to Noise Ratio}
+\usage{
+plot_snr(X, method = c("rmad", "pearson", "spearman", "kendall"))
+}
+\arguments{
+\item{X}{The data matrix to operate on}
+
+\item{method}{Required to select a correlation method}
+}
+\value{
+ggplot object
+}
+\description{
+Compute the stability scores for each entry and plot it
+against the estimate correlation coefficients.
+}
diff --git a/man/stability_score.Rd b/man/stability_score.Rd
new file mode 100644
index 0000000..c95ee8e
--- /dev/null
+++ b/man/stability_score.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/stability_score.R
+\name{stability_score}
+\alias{stability_score}
+\title{Stability Score}
+\usage{
+stability_score(X, K = 25, subsample_fraction = 0.7)
+}
+\arguments{
+\item{X}{The data matrix to operate on}
+
+\item{K}{Number of k-folds (default 25)}
+
+\item{subsample_fraction}{Hold out fraction (default 0.7)}
+}
+\value{
+Score array
+}
+\description{
+Computing entry wise stability score for selection
+}