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

Restructure classes and their responsibilities

Browse source
This commit is contained in:
Elias Projahn 2021-12-16 13:01:44 +01:00
parent 01ec301d6d
commit e2b93babe5
27 changed files with 974 additions and 634 deletions
Download patch file Download diff file Expand all files Collapse all files

11
man/analyze.Rd
View file

@ -2,7 +2,7 @@
% Please edit documentation in R/analyze.R
\name{analyze}
\alias{analyze}
\title{Analyze by applying the specified preset.}
\title{Analyze genes based on position data.}
\usage{
analyze(preset, progress = NULL)
}
@ -11,17 +11,18 @@ analyze(preset, progress = NULL)
\item{progress}{A function to be called for progress information. The
function should accept a number between 0.0 and 1.0 for the current
progress.}
progress. If no function is provided, a simple text progress bar will be
shown.}
}
\value{
An object containing the results of the analysis with the following
items:
\describe{
\item{\code{preset}}{The preset that was used.}
\item{\code{weights}}{The optimal weights for ranking the reference genes.}
\item{\code{ranking}}{The optimal ranking created using the weights.}
\item{\code{scores}}{Table containing all scores for each gene.}
\item{\code{results}}{Results from the different methods including details.}
}
}
\description{
Analyze by applying the specified preset.
Analyze genes based on position data.
}