| 
									
										
										
										
											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( | 
					
						
							| 
									
										
										
										
											2022-08-18 09:02:53 +02:00
										 |  |  |   reference_gene_sets, | 
					
						
							| 
									
										
										
										
											2022-05-19 16:28:59 +02:00
										 |  |  |   species_sets = NULL, | 
					
						
							| 
									
										
										
										
											2022-08-18 09:21:48 +02:00
										 |  |  |   methods = geposan::all_methods(), | 
					
						
							| 
									
										
										
										
											2022-08-18 09:02:53 +02:00
										 |  |  |   comparison_gene_sets = NULL, | 
					
						
							| 
									
										
										
										
											2022-05-19 16:28:59 +02:00
										 |  |  |   locked = FALSE, | 
					
						
							|  |  |  |   title = "Gene Position Analysis", | 
					
						
							|  |  |  |   port = 3464 | 
					
						
							|  |  |  | ) | 
					
						
							| 
									
										
										
										
											2021-10-20 15:34:52 +02:00
										 |  |  | } | 
					
						
							|  |  |  | \arguments{ | 
					
						
							| 
									
										
										
										
											2022-08-18 09:02:53 +02:00
										 |  |  | \item{reference_gene_sets}{A list of predefined gene sets to be used as | 
					
						
							|  |  |  | reference genes. This should be a named list containing vectors of gene IDs | 
					
						
							|  |  |  | for each set. You have to provide \emph{at least one gene set} which will be | 
					
						
							|  |  |  | selected as the initial reference gene set.} | 
					
						
							| 
									
										
										
										
											2022-05-19 16:24:23 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | \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.} | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-08-18 09:21:48 +02:00
										 |  |  | \item{methods}{A list of \code{\link[geposan:method]{geposan::method}} objects to be used for all | 
					
						
							|  |  |  | presets. By default, all available methods will be used.} | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-08-18 09:02:53 +02:00
										 |  |  | \item{comparison_gene_sets}{A named list of predefined gene sets to be used | 
					
						
							|  |  |  | as comparison genes.} | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-05-19 16:24:23 +02:00
										 |  |  | \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. | 
					
						
							|  |  |  | } |