mirror of
https://github.com/johrpan/geposan.git
synced 2025-10-26 10:47:25 +01:00
Restructure classes and their responsibilities
This commit is contained in:
parent
01ec301d6d
commit
e2b93babe5
27 changed files with 974 additions and 634 deletions
26
man/method.Rd
Normal file
26
man/method.Rd
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/method.R
|
||||
\name{method}
|
||||
\alias{method}
|
||||
\title{Describe a new method for analyzing gene position data.}
|
||||
\usage{
|
||||
method(id, name, description, func)
|
||||
}
|
||||
\arguments{
|
||||
\item{id}{Unique identifier for the method.}
|
||||
|
||||
\item{name}{Human readable name.}
|
||||
|
||||
\item{description}{Slightly longer description.}
|
||||
|
||||
\item{func}{Function to apply the method. The function should accept two
|
||||
parameters: an object of class \code{geposan_preset} as input and a function to
|
||||
report progress information to as a numeric value. The return value should
|
||||
be an object of class \code{geposan_result}.}
|
||||
}
|
||||
\value{
|
||||
An object of class \code{geposan_method}.
|
||||
}
|
||||
\description{
|
||||
Describe a new method for analyzing gene position data.
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue