geposan/man/adjacency.Rd

33 lines
941 B
Text
Raw Permalink Normal View History

% Generated by roxygen2: do not edit by hand
2022-01-26 09:58:33 +01:00
% Please edit documentation in R/method_adjacency.R
\name{adjacency}
\alias{adjacency}
\title{Score genes based on their proximity to the reference genes.}
\usage{
2022-06-22 11:20:39 +02:00
adjacency(
id = "adjacency",
name = "Adjacency",
description = "Adjacency to reference genes",
distance_estimate = densest
2022-06-22 11:20:39 +02:00
)
}
\arguments{
2022-06-22 11:20:39 +02:00
\item{id}{Unique ID for the method and its results.}
\item{name}{Human readable name for the method.}
\item{description}{Method description.}
2022-01-17 20:11:07 +01:00
\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.}
}
\value{
An object of class \code{geposan_method}.
}
\description{
2022-01-17 20:11:07 +01:00
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.
}