Skip to content

Commit

Permalink
Add documentation for gene_set_enrichment output table
Browse files Browse the repository at this point in the history
  • Loading branch information
lahuuki committed Dec 13, 2024
1 parent ed78c9c commit 3fa0e52
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions R/gene_set_enrichment.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3fa0e52

Please sign in to comment.