R/add_logfc.R

In neurogenomics/MultiEWCE: Multi-Scale Target Explorer

#' Add log fold-change
#'
#' Compute \code{log2(fold-change)} based on the effect size.
#' @param force_new Force the creation of a new \code{logFC} column
#'  even when one already exists.
#' @inheritParams prioritise_targets
#' @export
#' @examples
#' results = load_example_results()[seq(5000)]
#' add_logfc(results)
add_logfc <- function(results,
                      effect_var="estimate",
                      force_new=FALSE){
  logFC <- NULL;
  if(!"logFC" %in% names(results) || isTRUE(force_new)){
    messager("Adding logFC column.")
    results$logFC <- results[[effect_var]]+abs(min(results[[effect_var]]))
    results$logFC <- log2(results$logFC/mean(results$logFC))
    return(results)
  } else {
    messager("logFC already exists in results.",
             "Use `force_new=TRUE` to overwrite.")
    return(results)
  }
}