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

Use median by default in adjacency methods

Browse source
This commit is contained in:
Elias Projahn 2022-02-24 15:36:07 +01:00
parent 33cc33f81a
commit 074902b505
4 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

5
man/adjacency.Rd
View file

@ -4,7 +4,7 @@
\alias{adjacency}
\title{Score genes based on their proximity to the reference genes.}
\usage{
adjacency(distance_estimate = densest, summarize = min)
adjacency(distance_estimate = densest, summarize = stats::median)
}
\arguments{
\item{distance_estimate}{A function that will be used to summarize the
@ -12,8 +12,7 @@ distance values for each gene. See \code{\link[=densest]{densest()}} for the def
implementation.}
\item{summarize}{A function that will be used to combine the different
distances to the reference genes. By default \code{\link[=min]{min()}} is used. That means
the distance to the nearest reference gene will be scored.}
distances to the reference genes. By default \code{\link[stats:median]{stats::median()}} is used.}
}
\value{
An object of class \code{geposan_method}.