mirror of
https://github.com/johrpan/geposan.git
synced 2025-10-26 10:47:25 +01:00
39 lines
1.2 KiB
R
39 lines
1.2 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/validate.R
|
|
\name{validate}
|
|
\alias{validate}
|
|
\title{Perform cross-validation for the ranking.}
|
|
\usage{
|
|
validate(ranking, reference_gene_ids, method_ids, progress = NULL)
|
|
}
|
|
\arguments{
|
|
\item{ranking}{The ranking to validate.}
|
|
|
|
\item{reference_gene_ids}{The reference gene IDs whose ranking should be
|
|
validated.}
|
|
|
|
\item{method_ids}{IDs of the methods that were used.}
|
|
|
|
\item{progress}{An optional progress function that should accept a single
|
|
value between 0.0 and 1.0 for progress information.}
|
|
}
|
|
\value{
|
|
A validation object with the following items:
|
|
\describe{
|
|
\item{\code{validation}}{A \code{data.table} containing percentiles of the
|
|
comparison genes from the original ranking as well as their validation.
|
|
}
|
|
\item{\code{mean_score}}{The mean score of the genes.}
|
|
\item{\code{mean_percentile_original}}{The mean percentile of the genes in
|
|
the original ranking.
|
|
}
|
|
\item{\code{mean_percentile_validation}}{The mean percentile of the genes
|
|
when optimizing without themselves.
|
|
}
|
|
\item{\code{mean_error}}{The mean absolute error.}
|
|
}
|
|
}
|
|
\description{
|
|
This function reoptimizes the ranking leaving out one of the original
|
|
reference genes at a time.
|
|
}
|