mirror of
https://github.com/johrpan/geposan.git
synced 2025-10-26 18:57:25 +01:00
30 lines
909 B
R
30 lines
909 B
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/method_correlation.R
|
|
\name{correlation}
|
|
\alias{correlation}
|
|
\title{Score genes based on their correlation with the reference genes.}
|
|
\usage{
|
|
correlation(
|
|
id = "correlation",
|
|
name = "Correlation",
|
|
description = "Correlation with reference genes",
|
|
summarize = stats::median
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{id}{Unique ID for the method and its results.}
|
|
|
|
\item{name}{Human readable name for the method.}
|
|
|
|
\item{description}{Method description.}
|
|
|
|
\item{summarize}{A function for combining the different correlation
|
|
coefficients into one metric. By default, \code{\link[stats:median]{stats::median()}} is used. Other
|
|
suggested options include \code{\link[=max]{max()}} and \code{\link[=mean]{mean()}}.}
|
|
}
|
|
\value{
|
|
An object of class \code{geposan_method}.
|
|
}
|
|
\description{
|
|
Score genes based on their correlation with the reference genes.
|
|
}
|