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

ranking: Use S3 classes and rename optimize method

Browse source
This commit is contained in:
Elias Projahn 2021-11-05 14:47:33 +01:00
parent 4792bbaefd
commit 4992bb2930
5 changed files with 55 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

14
man/ranking.Rd
View file

@ -4,14 +4,20 @@
\alias{ranking}
\title{Rank the results by computing a score.}
\usage{
ranking(results, weights)
ranking(analysis, weights)
}
\arguments{
\item{results}{Results from \code{\link[=analyze]{analyze()}}.}
\item{analysis}{Analysis object resulting from \code{\link[=analyze]{analyze()}}.}
\item{weights}{Named list pairing method names with weighting factors.}
\item{weights}{Named list pairing method names with weighting factors. Only
methods that are contained within this list will be included.}
}
\value{
A ranking object. The object extends the analysis with additional
columns containing the \code{score} and the \code{rank} of each gene. It will be
ordered by rank.
}
\description{
This function takes the result from \code{\link[=analyze]{analyze()}} and creates a score by
This function takes the result of \code{\link[=analyze]{analyze()}} and creates a score by
computing a weighted mean across the different methods' results.
}