mirror of
https://github.com/johrpan/geposan.git
synced 2025-10-26 02:37:25 +01:00
31 lines
947 B
R
31 lines
947 B
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/method_proximity.R
|
|
\name{proximity}
|
|
\alias{proximity}
|
|
\title{Score the distance of genes to the telomeres across species.}
|
|
\usage{
|
|
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()}}.}
|
|
}
|
|
\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
|
|
distance across all genes and 1.0 corresponds to a distance of 0.
|
|
}
|