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

proximity: Use median distance by default

Browse source
This commit is contained in:
Elias Projahn 2022-02-24 17:44:04 +01:00
parent 99bc6794b9
commit 2fb48be0e3
2 changed files with 25 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

13
man/proximity.Rd
View file

@ -1,15 +1,20 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/proximity.R
% Please edit documentation in R/method_proximity.R
\name{proximity}
\alias{proximity}
\title{Score the mean distance of genes to the telomeres across species.}
\title{Score the distance of genes to the telomeres across species.}
\usage{
proximity()
proximity(summarize = stats::median)
}
\arguments{
\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()}}.}
}
\value{
An object of class \code{geposan_method}.
}
\description{
A score will be given to each gene such that 0.0 corresponds to the maximal
mean distance across all genes and 1.0 corresponds to a distance of 0.
distance across all genes and 1.0 corresponds to a distance of 0.
}