johrpan/geposan
1
0
Fork 0
mirror of https://github.com/johrpan/geposan.git synced 2025-10-26 02:37:25 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove species adjacency method

Browse source
This commit is contained in:
Elias Projahn 2022-06-28 13:06:59 +02:00
parent ab545a415c
commit 0ae6836d86
6 changed files with 0 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

3
man/adjacency.Rd
View file

@ -34,6 +34,3 @@ 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.
}
\seealso{
\code{\link[=species_adjacency]{species_adjacency()}}
}

37
man/species_adjacency.Rd
View file

@ -1,37 +0,0 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/method_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(
id = "species_adjacency",
name = "Species adj.",
description = "Species adjacency",
distance_estimate = stats::median,
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}{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()}}
}