Skip to content

Commit 92d9e78

Browse files
authored
Merge pull request #446 from atrigila/add_variancepartition_dream
Add `variancepartition/dream`
2 parents 45c61ff + 5bb2a49 commit 92d9e78

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1222
-526
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
### Added
99

10+
- [[#441](https://github.com/nf-core/differentialabundance/pull/441)] - Add dream differential module. ([@nschcolnicov](https://github.com/nschcolnicov) and [@alanmmobbs93](https://github.com/alanmobbs93), review by [@pinin4fjords](https://github.com/pinin4fjords), [@suzannejin](https://github.com/suzannejin) and [@grst](https://github.com/grst)).
1011
- [[#440](https://github.com/nf-core/differentialabundance/pull/440)] - Add handling for formula based contrasts. ([@nschcolnicov](https://github.com/nschcolnicov), review by [@pinin4fjords](https://github.com/pinin4fjords))
1112
- [[#437](https://github.com/nf-core/differentialabundance/pull/437)] - Add nf-tests to deseq2/differential, rmarkdownnotebook, and proteus modules. ([@nschcolnicov](https://github.com/nschcolnicov), review by [@TODO](TODO)).
1213
- [[#431](https://github.com/nf-core/differentialabundance/pull/431)] - Add differential and functional subworkflows. ([@suzannejin](https://github.com/suzannejin), co-authored by [@bjlang](https://github.com/bjlang) and [@caraiz2001](https://github.com/caraiz2001), review by [@pinin4fjords](https://github.com/pinin4fjords))

conf/modules.config

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,16 @@ process {
313313
].join(' ').trim() }
314314
}
315315

316+
withName: VARIANCEPARTITION_DREAM {
317+
publishDir = [
318+
[
319+
path: { "${params.outdir}/tables/differential" },
320+
mode: params.publish_dir_mode,
321+
pattern: '*.dream.results.tsv'
322+
]
323+
]
324+
}
325+
316326
withName: CUSTOM_FILTERDIFFERENTIALTABLE {
317327
ext.prefix = { "${input_file.toString().split("\\.").init().join(".")}" }
318328
publishDir = [

conf/rnaseq_dream.config

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/*
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
Nextflow config file for running RNA-seq analysis
4+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5+
Defines settings specific to RNA-seq analysis
6+
7+
Use as follows:
8+
nextflow run nf-core/differentialabundance -profile rnaseq_dream,<docker/singularity> --outdir <OUTDIR>
9+
10+
----------------------------------------------------------------------------------------
11+
*/
12+
13+
params {
14+
15+
config_profile_name = 'RNA-seq profile with `VARIANCEPARTITION_DREAM`'
16+
config_profile_description = 'Settings for RNA-seq analysis with `VARIANCEPARTITION_DREAM`'
17+
18+
// Study
19+
study_type = 'rnaseq'
20+
study_abundance_type = 'counts'
21+
22+
// Observations
23+
observations_id_col = 'sampleId'
24+
observations_name_col = 'sampleId'
25+
26+
// Differential options
27+
differential_use_dream = true
28+
differential_file_suffix = ".dream.results.tsv"
29+
differential_fc_column = "logFC"
30+
differential_pval_column = "P.Value"
31+
differential_qval_column = "adj.P.Val"
32+
differential_feature_id_column = "Geneid"
33+
differential_feature_name_column = "Geneid"
34+
35+
}

conf/test_rnaseq_dream.config

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
Nextflow config file for running RNA-seq analysis
4+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5+
Defines settings specific to RNA-seq analysis
6+
7+
Use as follows:
8+
nextflow run nf-core/differentialabundance -profile test_rnaseq_dream,<docker/singularity> --outdir <OUTDIR>
9+
10+
----------------------------------------------------------------------------------------
11+
*/
12+
13+
includeConfig 'rnaseq_dream.config'
14+
15+
16+
params {
17+
study_name = 'SRP254919'
18+
config_profile_name = 'Test RNAseq with DREAM'
19+
config_profile_description = 'Minimal test dataset to check pipeline function'
20+
21+
// Input data
22+
input = 'https://raw.githubusercontent.com/nf-core/test-datasets/modules/data/genomics/mus_musculus/rnaseq_expression/SRP254919.samplesheet.csv'
23+
matrix = 'https://raw.githubusercontent.com/nf-core/test-datasets/modules/data/genomics/mus_musculus/rnaseq_expression/SRP254919.salmon.merged.gene_counts.top1000cov.tsv'
24+
transcript_length_matrix = 'https://raw.githubusercontent.com/nf-core/test-datasets/modules/data/genomics/mus_musculus/rnaseq_expression/SRP254919.spoofed_lengths.tsv'
25+
contrasts_yml = 'https://raw.githubusercontent.com/nf-core/test-datasets/refs/heads/differentialabundance/testdata/formula_contrasts/SRP254919.contrasts.yaml'
26+
27+
// To do: replace this with a cut-down mouse GTF matching the matrix for testing
28+
gtf = 'https://ftp.ensembl.org/pub/release-81/gtf/mus_musculus/Mus_musculus.GRCm38.81.gtf.gz'
29+
30+
// Observations
31+
observations_id_col = 'sample'
32+
observations_name_col = 'sample'
33+
34+
// Features
35+
features_type = 'gene'
36+
features_id_col = 'gene_id'
37+
features_name_col = 'gene_name'
38+
features_metadata_cols = 'gene_id,gene_name,gene_biotype'
39+
40+
// Differential options
41+
differential_feature_id_column = "gene_id"
42+
differential_feature_name_column = "gene_name"
43+
differential_fc_column = "logFC"
44+
45+
// Apply a higher filter to check that the filtering works
46+
filtering_min_abundance = 10
47+
48+
// Exploratory
49+
exploratory_assay_names = "raw,normalised"
50+
exploratory_final_assay = "normalised"
51+
exploratory_log2_assays = 'raw,normalised'
52+
exploratory_main_variable = 'contrasts'
53+
54+
// Test dataset is too small for the nsub default value
55+
deseq2_vst_nsub = 500
56+
57+
// Activate GSEA
58+
gsea_run = true
59+
gene_sets_files = 'https://raw.githubusercontent.com/nf-core/test-datasets/modules/data/genomics/mus_musculus/gene_set_analysis/mh.all.v2022.1.Mm.symbols.gmt'
60+
gsea_rnd_seed = '10'
61+
62+
// Report options
63+
report_round_digits = 3
64+
report_contributors = 'Jane Doe\nDirector of Institute of Microbiology\nUniversity of Smallville;John Smith\nPhD student\nInstitute of Microbiology\nUniversity of Smallville'
65+
66+
}
67+
68+

docs/output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Most plots are included in the HTML report (see above), but are also included in
6969
- `raw.matrix.tsv`: RMA background corrected matrix (Affy)
7070
- `normalised.matrix.tsv`: RMA background corrected and normalised intensities matrix (Affy)
7171
- `differential/`: Directory containing tables of differential statistics reported by differential modules such as DESeq2
72-
- `[contrast_name].[deseq2|limma].results.tsv`: Results of DESeq2 differential analyis (RNA-seq) OR Limma differential analysis (Affymetrix arrays, GEO studies, Maxquant proteomics studies)
72+
- `[contrast_name].[deseq2|dream|limma].results.tsv`: Results of DESeq2 differential analyis (RNA-seq), DREAM differential analysis (RNA-seq for mixed linear models) OR Limma differential analysis (Affymetrix arrays, GEO studies, Maxquant proteomics studies)
7373
- `[contrast_name].[deseq2|limma].results_filtered.tsv`: Results of DESeq2 differential analyis (RNA-seq) OR Limma differential analysis (Affymetrix arrays, GEO studies, Maxquant proteomics studies); filtered for differentially abundant entries
7474
- `immunedeconv/`: Directory containing table of immunedeconv results
7575
- `${prefix}.deconvolution_results.tsv`: TSV output that contains estimated proportions of immune cell types for each sample

modules.json

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
},
4343
"deseq2/differential": {
4444
"branch": "master",
45-
"git_sha": "81880787133db07d9b4c1febd152c090eb8325dc",
45+
"git_sha": "25c228dd132d91596e87b636b0e03fd48d4c951a",
4646
"installed_by": ["abundance_differential_filter"]
4747
},
4848
"geoquery/getgeo": {
@@ -72,17 +72,17 @@
7272
},
7373
"limma/differential": {
7474
"branch": "master",
75-
"git_sha": "81880787133db07d9b4c1febd152c090eb8325dc",
75+
"git_sha": "25c228dd132d91596e87b636b0e03fd48d4c951a",
7676
"installed_by": ["abundance_differential_filter"]
7777
},
7878
"propr/grea": {
7979
"branch": "master",
80-
"git_sha": "81880787133db07d9b4c1febd152c090eb8325dc",
80+
"git_sha": "05954dab2ff481bcb999f24455da29a5828af08d",
8181
"installed_by": ["differential_functional_enrichment"]
8282
},
8383
"propr/propd": {
8484
"branch": "master",
85-
"git_sha": "785efc640b1e87e9ff4b451cf9b6970f0db7a03b",
85+
"git_sha": "25c228dd132d91596e87b636b0e03fd48d4c951a",
8686
"installed_by": ["abundance_differential_filter"]
8787
},
8888
"proteus/readproteingroups": {
@@ -112,14 +112,19 @@
112112
},
113113
"shinyngs/validatefomcomponents": {
114114
"branch": "master",
115-
"git_sha": "597771ff67e7d86a0ded1561eaa791b19c55deaa",
115+
"git_sha": "0d290ba0c91d488a47726adedc176f5fe443cf19",
116116
"installed_by": ["modules"]
117117
},
118118
"untar": {
119119
"branch": "master",
120120
"git_sha": "666652151335353eef2fcd58880bcef5bc2928e1",
121121
"installed_by": ["modules"]
122122
},
123+
"variancepartition/dream": {
124+
"branch": "master",
125+
"git_sha": "25c228dd132d91596e87b636b0e03fd48d4c951a",
126+
"installed_by": ["abundance_differential_filter", "modules"]
127+
},
123128
"zip": {
124129
"branch": "master",
125130
"git_sha": "666652151335353eef2fcd58880bcef5bc2928e1",
@@ -131,12 +136,12 @@
131136
"nf-core": {
132137
"abundance_differential_filter": {
133138
"branch": "master",
134-
"git_sha": "69b763e449ed23cb0faf2805b4b479f69c168782",
139+
"git_sha": "25c228dd132d91596e87b636b0e03fd48d4c951a",
135140
"installed_by": ["subworkflows"]
136141
},
137142
"differential_functional_enrichment": {
138143
"branch": "master",
139-
"git_sha": "100b1dc1ece11cf8d4fec100314d616a66a60875",
144+
"git_sha": "25c228dd132d91596e87b636b0e03fd48d4c951a",
140145
"installed_by": ["subworkflows"]
141146
},
142147
"utils_nextflow_pipeline": {

modules/nf-core/deseq2/differential/main.nf

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)