geposan/man/ranking.Rd

24 lines
817 B
Text
Raw Normal View History

2021-10-19 13:39:55 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ranking.R
\name{ranking}
\alias{ranking}
\title{Rank the results by computing a score.}
\usage{
2021-11-17 22:57:31 +01:00
ranking(analysis, weights)
2021-10-19 13:39:55 +02:00
}
\arguments{
\item{analysis}{Analysis object resulting from \code{\link[=analyze]{analyze()}}.}
2021-10-19 13:39:55 +02:00
\item{weights}{Named list pairing method names with weighting factors. Only
methods that are contained within this list will be included.}
}
\value{
2021-11-12 10:16:11 +01:00
A ranking object. The object extends the analysis result with
2021-12-29 16:09:18 +01:00
additional columns containing the \code{score}, the \code{rank} and the \code{percentile}
for each gene. It will be ordered by rank.
2021-10-19 13:39:55 +02:00
}
\description{
This function takes the result of \code{\link[=analyze]{analyze()}} and creates a score by
2021-10-19 13:39:55 +02:00
computing a weighted mean across the different methods' results.
}