Skip to content

Commit 1b1a00b

Browse files
authored
docs: mention that you can merge multiple GMT files for fgsea (#159)
This change allows for multiple gene set files to be specified. There are two things to especially consider in reviewing this: 1. Do we even want to enable this, or do we want to expect people to merge their `.gmt` files manually, to have just one comprehensive run of fgsea? This might be the favorable, as this would ensure multiple testing control across all specified gene sets at once. If we decide to do this, I would create a separate pull request to properly explain this in the `config.yaml` (and possiblye `README.md`) files. 2. Do we want to make this another breaking change, or can we simply tack this onto yesterday's `3.0.0` release with a minor version bump? <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Improved comments in configuration files to clarify requirements and best practices for providing gene set files when using the enrichment tool, including instructions on merging gene sets and citing sources. No changes to actual configuration options. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 29dedff commit 1b1a00b

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

.test/config/config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,11 @@ enrichment:
9191
fdr_genes: 0.05
9292
fdr_go_terms: 0.05
9393
fgsea:
94+
# If activated, you need to provide a GMT file with gene sets of interest.
95+
# A GMT file can contain multiple gene sets. So if you want to test for
96+
# enrichment in multiple sets of gene sets, please merge your gene sets
97+
# into one GMT file and provide this here. Don't forget to document your
98+
# gene set sources and to cite them upon publication.
9499
gene_sets_file: "ngs-test-data/ref/dummy.gmt"
95100
# tool is only run if set to `true`
96101
activate: true

.test/three_prime/config/config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,11 @@ enrichment:
9191
fdr_genes: 0.05
9292
fdr_go_terms: 0.05
9393
fgsea:
94+
# If activated, you need to provide a GMT file with gene sets of interest.
95+
# A GMT file can contain multiple gene sets. So if you want to test for
96+
# enrichment in multiple sets of gene sets, please merge your gene sets
97+
# into one GMT file and provide this here. Don't forget to document your
98+
# gene set sources and to cite them upon publication.
9499
gene_sets_file: "config/gene_sets.gmt"
95100
# tool is only run if set to `true`
96101
activate: true

config/config.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,11 @@ enrichment:
9393
fgsea:
9494
# tool is only run if set to `true`
9595
activate: false
96-
# if activated, you need to provide a GMT file with gene sets of interest
96+
# If activated, you need to provide a GMT file with gene sets of interest.
97+
# A GMT file can contain multiple gene sets. So if you want to test for
98+
# enrichment in multiple sets of gene sets, please merge your gene sets
99+
# into one GMT file and provide this here. Don't forget to document your
100+
# gene set sources and to cite them upon publication.
97101
gene_sets_file: "resources/gene_sets/dummy.gmt"
98102
fdr_gene_set: 0.05
99103
# minimum achievable p-value (equivalent to the reciprocal of the number of permutations, see fgsea docs)

0 commit comments

Comments
 (0)