johrpan/geposan
1
0
Fork 0
mirror of https://github.com/johrpan/geposan.git synced 2025-10-26 02:37:25 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

correlation: Make summary function customizable

Browse source 
This commit also changes the default behavior to using
`stats::median()`.
This commit is contained in:
Elias Projahn 2022-02-24 14:34:18 +01:00
parent 3cedc4fea4
commit 7fe07aceec
2 changed files with 19 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

7
man/correlation.Rd
View file

@ -4,7 +4,12 @@
\alias{correlation}
\title{Score genes based on their correlation with the reference genes.}
\usage{
correlation()
correlation(summarize = stats::median)
}
\arguments{
\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}.