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

Add comparison feature

Browse source
This commit is contained in:
Elias Projahn 2021-11-05 19:08:50 +01:00
parent 4992bb2930
commit f98800f1e0
5 changed files with 122 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
man/compare.Rd Normal file
View file

@ -0,0 +1,30 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/comparison.R
\name{compare}
\alias{compare}
\title{Compare a set of genes with the ranking.}
\usage{
compare(ranking, comparison_gene_ids)
}
\arguments{
\item{ranking}{A ranking created using \code{\link[=ranking]{ranking()}}.}
\item{comparison_gene_ids}{IDs of the genes of interest.}
}
\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{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{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.}
}
}
\description{
Compare a set of genes with the ranking.
}

14
man/print.geposan_comparison.Rd Normal file
View file

@ -0,0 +1,14 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/comparison.R
\name{print.geposan_comparison}
\alias{print.geposan_comparison}
\title{S3 method to print a comparison object.}
\usage{
\method{print}{geposan_comparison}(comparison, ...)
}
\description{
S3 method to print a comparison object.
}
\seealso{
\code{\link[=compare]{compare()}}
}