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

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

14
man/adjacency.Rd
View file

@ -4,9 +4,21 @@
\alias{adjacency}
\title{Score genes based on their proximity to the reference genes.}
\usage{
adjacency(distance_estimate = densest, summarize = stats::median)
adjacency(
id = "adjacency",
name = "Adjacency",
description = "Adjacency to reference genes",
distance_estimate = densest,
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{distance_estimate}{A function that will be used to summarize the
distance values for each gene. See \code{\link[=densest]{densest()}} for the default
implementation.}