geposanui/man/run_app.Rd

38 lines
1.2 KiB
Text
Raw Normal View History

2021-10-20 15:34:52 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/app.R
\name{run_app}
\alias{run_app}
\title{Run the application server.}
\usage{
2022-05-19 16:28:59 +02:00
run_app(
gene_sets,
species_sets = NULL,
locked = FALSE,
title = "Gene Position Analysis",
port = 3464
)
2021-10-20 15:34:52 +02:00
}
\arguments{
\item{gene_sets}{A list of predefined gene sets. This should be a named list
containing vectors of gene IDs for each set. The names will be used to
present the gene set throughout the user interface. You have to provide \emph{at
least one gene set} which will be selected as the initial reference gene
set.}
\item{species_sets}{A list of predefined species sets. This should be a named
list containing vectors of species IDs for each set. The names will be used
to present the species set throughout the user interface.}
\item{locked}{Whether the application should be locked and prohibit
performing custom analyses. If this is set to \code{TRUE}, only the predefined
gene and species sets are available for customizing the analysis. This may
be useful to limit resource usage on a publicly available instance.}
2022-05-19 16:28:59 +02:00
\item{title}{Set the title of the application.}
2021-10-20 15:34:52 +02:00
\item{port}{The port to serve the application on.}
}
\description{
Run the application server.
}