mirror of
https://github.com/johrpan/geposan.git
synced 2025-10-26 10:47:25 +01:00
Allow customizing method metadata
This commit is contained in:
parent
0e4f4621ed
commit
c6ca93b009
12 changed files with 139 additions and 30 deletions
|
|
@ -4,9 +4,20 @@
|
|||
\alias{correlation}
|
||||
\title{Score genes based on their correlation with the reference genes.}
|
||||
\usage{
|
||||
correlation(summarize = stats::median)
|
||||
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()}}.}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue