| 
									
										
										
										
											2021-10-19 13:39:55 +02:00
										 |  |  | % Generated by roxygen2: do not edit by hand | 
					
						
							|  |  |  | % Please edit documentation in R/ranking.R | 
					
						
							| 
									
										
										
										
											2021-11-05 14:47:33 +01:00
										 |  |  | \name{optimal_weights} | 
					
						
							|  |  |  | \alias{optimal_weights} | 
					
						
							| 
									
										
										
										
											2021-10-19 13:39:55 +02:00
										 |  |  | \title{Find the best weights to rank the results.} | 
					
						
							|  |  |  | \usage{ | 
					
						
							| 
									
										
										
										
											2021-11-17 22:57:31 +01:00
										 |  |  | optimal_weights(analysis, methods, reference_gene_ids, target = "mean") | 
					
						
							| 
									
										
										
										
											2021-10-19 13:39:55 +02:00
										 |  |  | } | 
					
						
							|  |  |  | \arguments{ | 
					
						
							| 
									
										
										
										
											2021-11-05 14:47:33 +01:00
										 |  |  | \item{analysis}{Results from \code{\link[=analyze]{analyze()}} or \code{\link[=ranking]{ranking()}}.} | 
					
						
							| 
									
										
										
										
											2021-10-19 13:39:55 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | \item{methods}{Methods to include in the score.} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | \item{reference_gene_ids}{IDs of the reference genes.} | 
					
						
							| 
									
										
										
										
											2021-10-21 11:42:44 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-11-22 14:10:22 +01:00
										 |  |  | \item{target}{The optimization target. It may be one of "mean", "median", | 
					
						
							|  |  |  | "min" or "max" and results in the respective rank being optimized.} | 
					
						
							| 
									
										
										
										
											2021-10-19 13:39:55 +02:00
										 |  |  | } | 
					
						
							|  |  |  | \value{ | 
					
						
							| 
									
										
										
										
											2021-11-05 14:47:33 +01:00
										 |  |  | Named list pairing method names with their optimal weights. This | 
					
						
							|  |  |  | can be used as an argument to \code{\link[=ranking]{ranking()}}. | 
					
						
							| 
									
										
										
										
											2021-10-19 13:39:55 +02:00
										 |  |  | } | 
					
						
							|  |  |  | \description{ | 
					
						
							|  |  |  | This function finds the optimal parameters to \code{\link[=ranking]{ranking()}} that result in the | 
					
						
							|  |  |  | reference genes ranking particulary high. | 
					
						
							|  |  |  | } |