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

method: Add context help

Browse source
This commit is contained in:
Elias Projahn 2024-01-31 12:14:55 +01:00
parent a3cc6a8796
commit 50e2fb260f
7 changed files with 28 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
man/method.Rd
View file

@ -4,7 +4,7 @@
\alias{method}
\title{Describe a new method for analyzing gene position data.}
\usage{
method(id, name, description, func)
method(id, name, description, help, func)
}
\arguments{
\item{id}{Unique identifier for the method.}
@ -13,6 +13,8 @@ method(id, name, description, func)
\item{description}{Slightly longer description.}
\item{help}{Context help for user interfaces.}
\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