johrpan/geposan
1
0
Fork 0
mirror of https://github.com/johrpan/geposan.git synced 2025-10-26 18:57:25 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Allow customizing method metadata

Browse source
This commit is contained in:
Elias Projahn 2022-06-22 11:20:39 +02:00
parent 0e4f4621ed
commit c6ca93b009
12 changed files with 139 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

13
man/proximity.Rd
View file

@ -4,9 +4,20 @@
\alias{proximity}
\title{Score the distance of genes to the telomeres across species.}
\usage{
proximity(summarize = stats::median)
proximity(
id = "proximity",
name = "Proximity",
description = "Proximity to telomeres",
summarize = stats::median
)
}
\arguments{
\item{id}{Unique ID for the method and its results.}
\item{name}{Human readable name for the method.}
\item{description}{Method description.}
\item{summarize}{A function for combining the different proximities into one
metric. By default, \code{\link[stats:median]{stats::median()}} is used. Other suggested options
include \code{\link[=min]{min()}} and \code{\link[=mean]{mean()}}.}