geposan/man/species_adjacency.Rd

26 lines
844 B
Text
Raw Permalink Normal View History

2022-01-17 20:11:07 +01:00
% Generated by roxygen2: do not edit by hand
2022-01-26 09:58:33 +01:00
% Please edit documentation in R/method_species_adjacency.R
2022-01-17 20:11:07 +01:00
\name{species_adjacency}
\alias{species_adjacency}
\title{Score genes based on their adjacency to the reference genes within species.}
\usage{
species_adjacency(distance_estimate = stats::median, summarize = stats::median)
2022-01-17 20:11:07 +01:00
}
\arguments{
\item{distance_estimate}{Function for combining the distance differences
within one species.}
\item{summarize}{Function for summarizing the distance values across species.}
}
\value{
An object of class \code{geposan_method}.
}
\description{
For each gene and species, the method will first combine the gene's distances
to the reference genes within that species. Afterwards, the results are
summarized across species and determine the gene's score.
}
\seealso{
\code{\link[=adjacency]{adjacency()}}
}