From 3fa0e524bd06e7ecef9f79062ed9ecf69e13d4c2 Mon Sep 17 00:00:00 2001 From: Louise Huuki Date: Fri, 13 Dec 2024 15:41:01 -0500 Subject: [PATCH] Add documentation for gene_set_enrichment output table --- R/gene_set_enrichment.R | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/R/gene_set_enrichment.R b/R/gene_set_enrichment.R index 1accea28..0d021144 100644 --- a/R/gene_set_enrichment.R +++ b/R/gene_set_enrichment.R @@ -15,6 +15,16 @@ #' #' @return A table in long format with the enrichment results using #' [stats::fisher.test()]. +#' * `OR` odds ratio. +#' * `Pval` p-value for `fisher.test()`. +#' * `test` group or layer in the `modeling_results`. +#' * `NumSig` Number of genes from the gene set present in `modeling_results` & +#' with `fdr < fdr_cut` and `t_stat > 0` (unless reverse = TRUE) for `test` in +#' modeling results. +#' * `SetSize` Number of genes from `modeling_results` present in `gene_set`. +#' * `ID` name of gene set. +#' * `model_type` record of input model type from `modeling results`. +#' * `fdr_cut` record of input `frd_cut`. #' #' @export #' @importFrom stats fisher.test