geposan/man/analyze.Rd

24 lines
727 B
Text
Raw Normal View History

2021-10-19 13:39:55 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/analyze.R
\name{analyze}
\alias{analyze}
\title{Analyze by applying the specified preset.}
\usage{
2021-10-19 15:03:10 +02:00
analyze(preset, progress = NULL)
2021-10-19 13:39:55 +02:00
}
\arguments{
\item{preset}{The preset to use which can be created using \code{\link[=preset]{preset()}}.}
2021-10-19 15:03:10 +02:00
\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.}
2021-10-19 13:39:55 +02:00
}
\value{
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.
}