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

Regenerate documentation

Browse source
This commit is contained in:
Elias Projahn 2021-11-22 14:10:22 +01:00
parent 2f3dc80a2f
commit 255123c74f
3 changed files with 21 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
man/optimal_weights.Rd
View file

@ -13,8 +13,8 @@ optimal_weights(analysis, methods, reference_gene_ids, target = "mean")
\item{reference_gene_ids}{IDs of the reference genes.}
\item{target}{The optimization target. It may be one of "mean", "min" or
"max" and results in the respective rank being optimized.}
\item{target}{The optimization target. It may be one of "mean", "median",
"min" or "max" and results in the respective rank being optimized.}
}
\value{
Named list pairing method names with their optimal weights. This

17
man/plot_chromosomes.Rd Normal file
View file

@ -0,0 +1,17 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plots.R
\name{plot_chromosomes}
\alias{plot_chromosomes}
\title{Show the distribution of scores across chromosomes.}
\usage{
plot_chromosomes(ranking)
}
\arguments{
\item{ranking}{The ranking to visualize.}
}
\description{
This function requires the package \code{plotly}.
}
\seealso{
ranking()
}

3
man/preset.Rd
View file

@ -6,7 +6,7 @@
\usage{
preset(
methods = c("clusteriness", "clusteriness_positions", "correlation",
"correlation_positions", "neural", "neural_positions", "proximity"),
"correlation_positions", "neural", "proximity"),
species_ids = NULL,
gene_ids = NULL,
reference_gene_ids = NULL,
@ -55,6 +55,7 @@ position data.
Available optimization targets are:
\itemize{
\item \code{mean} Mean rank of the reference genes.
\item \code{median} Median rank of the reference genes.
\item \code{max} First rank of the reference genes.
\item \code{min} Last rank of the reference genes.
}