| 
									
										
										
										
											2021-12-16 13:01:44 +01:00
										 |  |  | % Generated by roxygen2: do not edit by hand | 
					
						
							| 
									
										
										
										
											2022-01-26 09:58:33 +01:00
										 |  |  | % Please edit documentation in R/method_correlation.R | 
					
						
							| 
									
										
										
										
											2021-12-16 13:01:44 +01:00
										 |  |  | \name{correlation} | 
					
						
							|  |  |  | \alias{correlation} | 
					
						
							| 
									
										
										
										
											2022-01-09 21:32:37 +01:00
										 |  |  | \title{Score genes based on their correlation with the reference genes.} | 
					
						
							| 
									
										
										
										
											2021-12-16 13:01:44 +01:00
										 |  |  | \usage{ | 
					
						
							| 
									
										
										
										
											2022-02-24 14:34:18 +01:00
										 |  |  | correlation(summarize = stats::median) | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | \arguments{ | 
					
						
							|  |  |  | \item{summarize}{A function for combining the different correlation | 
					
						
							|  |  |  | coefficients into one metric. By default, \code{\link[stats:median]{stats::median()}} is used. Other | 
					
						
							|  |  |  | suggested options include \code{\link[=max]{max()}} and \code{\link[=mean]{mean()}}.} | 
					
						
							| 
									
										
										
										
											2021-12-16 13:01:44 +01:00
										 |  |  | } | 
					
						
							|  |  |  | \value{ | 
					
						
							|  |  |  | An object of class \code{geposan_method}. | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | \description{ | 
					
						
							| 
									
										
										
										
											2022-01-09 21:32:37 +01:00
										 |  |  | Score genes based on their correlation with the reference genes. | 
					
						
							| 
									
										
										
										
											2021-12-16 13:01:44 +01:00
										 |  |  | } |