preset: Turn into S3 class

This commit is contained in:
Elias Projahn 2021-11-03 14:17:39 +01:00
parent 6494ae8200
commit 55958e0d85
8 changed files with 106 additions and 43 deletions

View file

@ -1,19 +1,24 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/analyze.R
% Please edit documentation in R/preset.R
\name{preset}
\alias{preset}
\title{Create a new preset.}
\usage{
preset(methods, species, genes, reference_genes)
preset(
methods = c("clusteriness", "correlation", "neural", "proximity"),
species_ids = NULL,
gene_ids = NULL,
reference_gene_ids = NULL
)
}
\arguments{
\item{methods}{IDs of methods to apply.}
\item{methods}{Methods to apply.}
\item{species}{IDs of species to include.}
\item{species_ids}{IDs of species to include.}
\item{genes}{IDs of genes to screen.}
\item{gene_ids}{IDs of genes to screen.}
\item{reference_genes}{IDs of reference genes to compare to.}
\item{reference_gene_ids}{IDs of reference genes to compare to.}
}
\value{
The preset to use with \code{\link[=analyze]{analyze()}}.