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

Improve documentation for rank_genes()

Browse source
This commit is contained in:
Elias Projahn 2024-04-26 19:35:05 +02:00
parent 7828f9c71e
commit a9643ca6dc
2 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
man/rank_genes.Rd
View file

@ -17,6 +17,24 @@ rank_genes(
\arguments{
\item{data}{The input data to use. This should either be the result of a
previous call to this function or the return value of \code{\link[=analyze]{analyze()}}.}
\item{cross_sample_metric}{Name of the column that should be used as the
metric measuring the expression across samples.}
\item{cross_sample_weight}{Relative weight that should be assigned to the
cross sample metric.}
\item{level_metric}{Name of the column that should be used to represent
overall expression levels.}
\item{level_weight}{Relative weight that should be assigned to the level
metric.}
\item{variation_metric}{Name of the column that should be used as the metric
representing variation in expression.}
\item{variation_weight}{Relative weight that should be assigned to the
variation metric.}
}
\value{
A \code{data.table} with gene data as well as the scores, ranks and