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

comparison: Add more useful information

Browse source
This commit is contained in:
Elias Projahn 2022-01-26 10:56:35 +01:00
parent c633b17db6
commit 016a9ada9d
2 changed files with 44 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

10
man/compare.Rd
View file

@ -14,12 +14,12 @@ compare(ranking, comparison_gene_ids)
\value{
A comparison object with the following items:
\describe{
\item{\code{mean}}{The mean score of the genes.}
\item{\code{min}}{The lowest score of the genes.}
\item{\code{max}}{The highest score of the genes.}
\item{\code{quantiles}}{A \code{data.table} containing quantile values for the
score, rank and percentile of the comparison genes.
}
\item{\code{mean_score}}{The mean score of the genes.}
\item{\code{mean_rank}}{The mean rank of the genes.}
\item{\code{first_rank}}{The first rank of the genes.}
\item{\code{last_rank}}{The last rank of the genes.}
\item{\code{mean_percentile}}{The mean percentile of the genes.}
\item{\code{p_value}}{p-value for the null hypothesis that the comparison
genes do \emph{not} rank better than other genes. In other words: A low
p-value means that the comparison genes rank particularly high.}