geposan/man/optimal_weights.Rd

27 lines
920 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{optimal_weights}
\alias{optimal_weights}
2021-10-19 13:39:55 +02:00
\title{Find the best weights to rank the results.}
\usage{
optimal_weights(analysis, methods, reference_gene_ids, target = "mean")
2021-10-19 13:39:55 +02:00
}
\arguments{
\item{analysis}{Results from \code{\link[=analyze]{analyze()}} or \code{\link[=ranking]{ranking()}}.}
2021-10-19 13:39:55 +02:00
\item{methods}{Methods to include in the score.}
\item{reference_gene_ids}{IDs of the reference genes.}
2021-10-21 11:42:44 +02:00
\item{target}{The optimization target. It may be one of "mean", "min" or
"max" and results in the respective rank being optimized.}
2021-10-19 13:39:55 +02:00
}
\value{
Named list pairing method names with their optimal weights. This
can be used as an argument to \code{\link[=ranking]{ranking()}}.
2021-10-19 13:39:55 +02:00
}
\description{
This function finds the optimal parameters to \code{\link[=ranking]{ranking()}} that result in the
reference genes ranking particulary high.
}