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

analyze: Include preset in result

Browse source
This commit is contained in:
Elias Projahn 2021-11-12 10:16:11 +01:00
parent 6d9511fa2e
commit 910eb06fe9
4 changed files with 32 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

12
man/analyze.Rd
View file

@ -14,10 +14,14 @@ function should accept a number between 0.0 and 1.0 for the current
progress.}
}
\value{
An object containing the results of the analysis. It contains a
\link{data.table} with one row for each gene identified by it's ID (\code{gene}
column). The additional columns contain the resulting scores per method
and are named after the method IDs.
An object containing the results of the analysis with the following
items:
\describe{
\item{\code{preset}}{The preset that was used.}
\item{\code{results}}{A \link{data.table} with one row for each gene identified by
it's ID (\code{gene} column). The additional columns contain the resulting
scores per method and are named after the method IDs.}
}
}
\description{
Analyze by applying the specified preset.

6
man/ranking.Rd
View file

@ -13,9 +13,9 @@ ranking(analysis, weights)
methods that are contained within this list will be included.}
}
\value{
A ranking object. The object extends the analysis with additional
columns containing the \code{score} and the \code{rank} of each gene. It will be
ordered by rank.
A ranking object. The object extends the analysis result with
additional columns containing the \code{score} and the \code{rank} of each gene. It
will be ordered by rank.
}
\description{
This function takes the result of \code{\link[=analyze]{analyze()}} and creates a score by