R/add.res.to.merging.list.R

In EWCE: Expression Weighted Celltype Enrichment

#' Add to results to merging list
#'
#' \code{add.res.to.merging.list} Adds EWCE results to a list for merging analysis
#'
#' @param full_res results list generated using \code{\link{bootstrap.enrichment.test}} or \code{\link{ewce_expression_data}} functions. Multiple results tables can be merged into one results table, as long as the 'list' column is set to distinguish them.
#' @param existing_results Output of previous rounds from adding results to list. Leave empty if this is the first item in the list.
#' @return merged results list
#' @examples
#' # Load the single cell data
#' data(celltype_data)
#'
#' # Load the data
#' data(tt_alzh)
#' data(tt_alzh_BA36)
#' data(tt_alzh_BA44)
#'
#' # Run EWCE analysis
#' tt_results = ewce_expression_data(sct_data=celltype_data,tt=tt_alzh)
#' tt_results_36 = ewce_expression_data(sct_data=celltype_data,tt=tt_alzh_BA36)
#' tt_results_44 = ewce_expression_data(sct_data=celltype_data,tt=tt_alzh_BA44)
#'
#' # Fill a list with the results
#' results = add.res.to.merging.list(tt_alzh)
#' results = add.res.to.merging.list(tt_alzh_BA36,results)
#' results = add.res.to.merging.list(tt_alzh_BA44,results)
#' @export
add.res.to.merging.list <- function(full_res,existing_results=NULL){
    # Check if the results set is directional
    if(is.null(full_res$bootstrap_data)){
        # If it is directional, and other results are in list, check they are all directional
        if(!is.null(existing_results)){
            for(i in 1:length(existing_results)){
                if(is.null(existing_results[[i]]$Direction)){stop("ERROR: Cannot merge directional with non-directional results table")}
            }
        }
        # Setup the new entries
        new_entry_up   = list(Direction="Up",bootstrap_data=full_res$bootstrap_data.up, hitCells=full_res$hit.cells.up)
        new_entry_down = list(Direction="Down",bootstrap_data=full_res$bootstrap_data.down, hitCells=full_res$hit.cells.down)
        # Add them to the list
        if(is.null(existing_results)){
            existing_results = list(new_entry_up)
        }else{
            existing_results[[length(existing_results)+1]] <- new_entry_up
        }
        existing_results[[length(existing_results)+1]] <- new_entry_down
    }else{
        # If the list is NOT directional
        # If it is NOT directional, and other results are in list, check they are all not directional
        if(!is.null(existing_results)){
            for(i in 1:length(existing_results)){
                if(!is.null(existing_results[[i]]$Direction)){stop("ERROR: Cannot merge directional with non-directional results table")}
            }
        }
        # Setup the new entries
        new_entry   = list(bootstrap_data=full_res$bootstrap_data, hitCells=full_res$hit.cells)
        # Add new entry to the list
        if(is.null(existing_results)){
            existing_results = list(new_entry)
        }else{
            existing_results[[length(existing_results)+1]] <- new_entry
        }
    }
    return(existing_results)
}