mirror of
https://github.com/johrpan/geposan.git
synced 2025-10-26 10:47:25 +01:00
36 lines
1.1 KiB
R
36 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/method_adjacency.R
|
|
\name{adjacency}
|
|
\alias{adjacency}
|
|
\title{Score genes based on their proximity to the reference genes.}
|
|
\usage{
|
|
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.}
|
|
|
|
\item{summarize}{A function that will be used to combine the different
|
|
distances to the reference genes. By default \code{\link[stats:median]{stats::median()}} is used.}
|
|
}
|
|
\value{
|
|
An object of class \code{geposan_method}.
|
|
}
|
|
\description{
|
|
In this case, the distance data that is available for one gene is first
|
|
combined. The resulting value is compared to the reference genes and
|
|
determines the gene's score in relation to other genes.
|
|
}
|