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

Add species adjacency method

Browse source
This commit is contained in:
Elias Projahn 2022-01-17 20:11:07 +01:00
parent c8f1e522f9
commit 53f955f3da
6 changed files with 202 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

25
man/species_adjacency.Rd Normal file
View file

@ -0,0 +1,25 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/species_adjacency.R
\name{species_adjacency}
\alias{species_adjacency}
\title{Score genes based on their adjacency to the reference genes within species.}
\usage{
species_adjacency(distance_estimate = min, summarize = stats::median)
}
\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()}}
}