-
Notifications
You must be signed in to change notification settings - Fork 855
Expand file tree
/
Copy pathro-crate-metadata.json
More file actions
324 lines (324 loc) · 22.5 KB
/
ro-crate-metadata.json
File metadata and controls
324 lines (324 loc) · 22.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
{
"@context": [
"https://w3id.org/ro/crate/1.1/context",
{
"GithubService": "https://w3id.org/ro/terms/test#GithubService",
"JenkinsService": "https://w3id.org/ro/terms/test#JenkinsService",
"PlanemoEngine": "https://w3id.org/ro/terms/test#PlanemoEngine",
"TestDefinition": "https://w3id.org/ro/terms/test#TestDefinition",
"TestInstance": "https://w3id.org/ro/terms/test#TestInstance",
"TestService": "https://w3id.org/ro/terms/test#TestService",
"TestSuite": "https://w3id.org/ro/terms/test#TestSuite",
"TravisService": "https://w3id.org/ro/terms/test#TravisService",
"definition": "https://w3id.org/ro/terms/test#definition",
"engineVersion": "https://w3id.org/ro/terms/test#engineVersion",
"instance": "https://w3id.org/ro/terms/test#instance",
"resource": "https://w3id.org/ro/terms/test#resource",
"runsOn": "https://w3id.org/ro/terms/test#runsOn"
}
],
"@graph": [
{
"@id": "./",
"@type": "Dataset",
"creativeWorkStatus": "InProgress",
"datePublished": "2026-02-25T10:00:00+00:00",
"description": "<h1>\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"docs/images/nf-core-rnaseq_logo_dark.png\">\n <img alt=\"nf-core/rnaseq\" src=\"docs/images/nf-core-rnaseq_logo_light.png\">\n </picture>\n</h1>\n\n[](https://github.com/codespaces/new/nf-core/rnaseq)\n[](https://github.com/nf-core/rnaseq/actions/workflows/nf-test.yml)\n[](https://github.com/nf-core/rnaseq/actions/workflows/linting.yml)[](https://nf-co.re/rnaseq/results)[](https://doi.org/10.5281/zenodo.1400710)\n[](https://www.nf-test.com)\n\n[](https://www.nextflow.io/)\n[](https://github.com/nf-core/tools/releases/tag/3.5.1)\n[](https://docs.conda.io/en/latest/)\n[](https://www.docker.com/)\n[](https://sylabs.io/docs/)\n[](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/rnaseq)\n\n[](https://nfcore.slack.com/channels/rnaseq)[](https://bsky.app/profile/nf-co.re)[](https://mstdn.science/@nf_core)[](https://www.youtube.com/c/nf-core)\n\n## Introduction\n\n**nf-core/rnaseq** is a bioinformatics pipeline that can be used to analyse RNA sequencing data obtained from organisms with a reference genome and annotation. It takes a samplesheet with FASTQ files or pre-aligned BAM files as input, performs quality control (QC), trimming and (pseudo-)alignment, and produces a gene expression matrix and extensive QC report.\n\n\n\n> In case the image above is not loading, please have a look at the [static version](docs/images/nf-core-rnaseq_metro_map_grey.png).\n\n1. Merge re-sequenced FastQ files ([`cat`](http://www.linfo.org/cat.html))\n2. Auto-infer strandedness by subsampling and pseudoalignment ([`fq`](https://github.com/stjude-rust-labs/fq), [`Salmon`](https://combine-lab.github.io/salmon/))\n3. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))\n4. UMI extraction ([`UMI-tools`](https://github.com/CGATOxford/UMI-tools))\n5. Adapter and quality trimming ([`Trim Galore!`](https://www.bioinformatics.babraham.ac.uk/projects/trim_galore/))\n6. Removal of genome contaminants ([`BBSplit`](http://seqanswers.com/forums/showthread.php?t=41288))\n7. Removal of ribosomal RNA ([`SortMeRNA`](https://github.com/biocore/sortmerna))\n8. Choice of multiple alignment and quantification routes (_For `STAR` the sentieon implementation can be chosen_):\n 1. [`STAR`](https://github.com/alexdobin/STAR) -> [`Salmon`](https://combine-lab.github.io/salmon/)\n 2. [`STAR`](https://github.com/alexdobin/STAR) -> [`RSEM`](https://github.com/deweylab/RSEM)\n 3. [`HiSAT2`](https://ccb.jhu.edu/software/hisat2/index.shtml) -> **NO QUANTIFICATION**\n9. Sort and index alignments ([`SAMtools`](https://sourceforge.net/projects/samtools/files/samtools/))\n10. UMI-based deduplication ([`UMI-tools`](https://github.com/CGATOxford/UMI-tools))\n11. Duplicate read marking ([`picard MarkDuplicates`](https://broadinstitute.github.io/picard/))\n12. Transcript assembly and quantification ([`StringTie`](https://ccb.jhu.edu/software/stringtie/))\n13. Create bigWig coverage files ([`BEDTools`](https://github.com/arq5x/bedtools2/), [`bedGraphToBigWig`](http://hgdownload.soe.ucsc.edu/admin/exe/))\n14. Extensive quality control:\n 1. [`RSeQC`](http://rseqc.sourceforge.net/)\n 2. [`Qualimap`](http://qualimap.bioinfo.cipf.es/)\n 3. [`dupRadar`](https://bioconductor.org/packages/release/bioc/html/dupRadar.html)\n 4. [`Preseq`](http://smithlabresearch.org/software/preseq/)\n 5. [`DESeq2`](https://bioconductor.org/packages/release/bioc/html/DESeq2.html)\n 6. Contamination detection on unaligned sequences; _optional_\n 1. [`Kraken2`](https://ccb.jhu.edu/software/kraken2/) -> [`Bracken`](https://ccb.jhu.edu/software/bracken/)\n 2. [`Sylph`](https://sylph-docs.github.io/)\n15. Pseudoalignment and quantification ([`Salmon`](https://combine-lab.github.io/salmon/) or ['Kallisto'](https://pachterlab.github.io/kallisto/); _optional_)\n16. Present QC for raw read, alignment, gene biotype, sample similarity, and strand-specificity checks ([`MultiQC`](http://multiqc.info/), [`R`](https://www.r-project.org/))\n\n> **Note**\n> The SRA download functionality has been removed from the pipeline (`>=3.2`) and ported to an independent workflow called [nf-core/fetchngs](https://nf-co.re/fetchngs). You can provide `--nf_core_pipeline rnaseq` when running nf-core/fetchngs to download and auto-create a samplesheet containing publicly available samples that can be accepted directly as input by this pipeline.\n\n> **Warning**\n> Quantification isn't performed if using `--aligner hisat2` due to the lack of an appropriate option to calculate accurate expression estimates from HISAT2 derived genomic alignments. However, you can use this route if you have a preference for the alignment, QC and other types of downstream analysis compatible with the output of HISAT2.\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.\n\nFirst, prepare a samplesheet with your input data that looks as follows:\n\n**samplesheet.csv**:\n\n```csv\nsample,fastq_1,fastq_2,strandedness\nCONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz,auto\nCONTROL_REP1,AEG588A1_S1_L003_R1_001.fastq.gz,AEG588A1_S1_L003_R2_001.fastq.gz,auto\nCONTROL_REP1,AEG588A1_S1_L004_R1_001.fastq.gz,AEG588A1_S1_L004_R2_001.fastq.gz,auto\n```\n\nEach row represents a fastq file (single-end) or a pair of fastq files (paired end). Rows with the same sample identifier are considered technical replicates and merged automatically. The strandedness refers to the library preparation and will be automatically inferred if set to `auto`.\n\nThe pipeline supports a two-step reprocessing workflow using BAM files from previous runs. Run initially with `--save_align_intermeds` to generate a samplesheet with BAM paths, then reprocess using `--skip_alignment` for efficient downstream analysis without repeating expensive alignment steps. This feature is designed specifically for pipeline-generated BAMs.\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).\n\nNow, you can run the pipeline using:\n\n```bash\nnextflow run nf-core/rnaseq \\\n --input <SAMPLESHEET> \\\n --outdir <OUTDIR> \\\n --gtf <GTF> \\\n --fasta <GENOME FASTA> \\\n -profile <docker/singularity/.../institute>\n```\n\nFor more details and further functionality, please refer to the [usage documentation](https://nf-co.re/rnaseq/usage) and the [parameter documentation](https://nf-co.re/rnaseq/parameters).\n\n## Pipeline output\n\nTo see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/rnaseq/results) tab on the nf-core website pipeline page.\nFor more details about the output files and reports, please refer to the\n[output documentation](https://nf-co.re/rnaseq/output).\n\nThis pipeline quantifies RNA-sequenced reads relative to genes/transcripts in the genome and normalizes the resulting data. It does not compare the samples statistically in order to assign significance in the form of FDR or P-values. For downstream analyses, the output files from this pipeline can be analysed directly in statistical environments like [R](https://www.r-project.org/), [Julia](https://julialang.org/) or via the [nf-core/differentialabundance](https://github.com/nf-core/differentialabundance/) pipeline.\n\n## Online videos\n\nA short talk about the history, current status and functionality on offer in this pipeline was given by Harshil Patel ([@drpatelh](https://github.com/drpatelh)) on [8th February 2022](https://nf-co.re/events/2022/bytesize-32-nf-core-rnaseq) as part of the nf-core/bytesize series.\n\nYou can find numerous talks on the [nf-core events page](https://nf-co.re/events) from various topics including writing pipelines/modules in Nextflow DSL2, using nf-core tooling, running nf-core pipelines as well as more generic content like contributing to Github. Please check them out!\n\n## Credits\n\nThese scripts were originally written for use at the [National Genomics Infrastructure](https://ngisweden.scilifelab.se), part of [SciLifeLab](http://www.scilifelab.se/) in Stockholm, Sweden, by Phil Ewels ([@ewels](https://github.com/ewels)) and Rickard Hammar\u00e9n ([@Hammarn](https://github.com/Hammarn)).\n\nThe pipeline was re-written in Nextflow DSL2 by Harshil Patel ([@drpatelh](https://github.com/drpatelh)) from [Seqera Labs, Spain](https://seqera.io/), and is currently maintained by Jonathan Manning ([@pinin4fjords](https://github.com/pinin4fjords)) and the nf-core community.\n\nThe pipeline workflow diagram was initially designed by Sarah Guinchard ([@G-Sarah](https://github.com/G-Sarah)) and James Fellows Yates ([@jfy133](https://github.com/jfy133)), further modifications where made by Harshil Patel ([@drpatelh](https://github.com/drpatelh)) and Maxime Garcia ([@maxulysse](https://github.com/maxulysse)).\n\nMany thanks to other who have helped out along the way too, including (but not limited to):\n\n- [Alex Peltzer](https://github.com/apeltzer)\n- [Colin Davenport](https://github.com/colindaven)\n- [Denis Moreno](https://github.com/Galithil)\n- [Edmund Miller](https://github.com/edmundmiller)\n- [Gregor Sturm](https://github.com/grst)\n- [Jacki Buros Novik](https://github.com/jburos)\n- [Lorena Pantano](https://github.com/lpantano)\n- [Matthias Zepper](https://github.com/MatthiasZepper)\n- [Maxime Garcia](https://github.com/maxulysse)\n- [Olga Botvinnik](https://github.com/olgabot)\n- [@orzechoj](https://github.com/orzechoj)\n- [Paolo Di Tommaso](https://github.com/pditommaso)\n- [Rob Syme](https://github.com/robsyme)\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#rnaseq` channel](https://nfcore.slack.com/channels/rnaseq) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\nIf you use nf-core/rnaseq for your analysis, please cite it using the following doi: [10.5281/zenodo.1400710](https://doi.org/10.5281/zenodo.1400710)\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nYou can cite the `nf-core` publication as follows:\n\n> **The nf-core framework for community-curated bioinformatics pipelines.**\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n",
"hasPart": [
{
"@id": "main.nf"
},
{
"@id": "assets/"
},
{
"@id": "conf/"
},
{
"@id": "docs/"
},
{
"@id": "docs/images/"
},
{
"@id": "modules/"
},
{
"@id": "modules/nf-core/"
},
{
"@id": "workflows/"
},
{
"@id": "subworkflows/"
},
{
"@id": "nextflow.config"
},
{
"@id": "README.md"
},
{
"@id": "nextflow_schema.json"
},
{
"@id": "CHANGELOG.md"
},
{
"@id": "LICENSE"
},
{
"@id": "CODE_OF_CONDUCT.md"
},
{
"@id": "CITATIONS.md"
},
{
"@id": "modules.json"
},
{
"@id": "docs/usage.md"
},
{
"@id": "docs/output.md"
},
{
"@id": ".nf-core.yml"
},
{
"@id": ".pre-commit-config.yaml"
},
{
"@id": ".prettierignore"
}
],
"isBasedOn": "https://github.com/nf-core/rnaseq",
"license": "MIT",
"mainEntity": {
"@id": "main.nf"
},
"mentions": [
{
"@id": "#0ad48f19-9581-4e1b-b10f-638ab0a48482"
}
],
"name": "nf-core/rnaseq"
},
{
"@id": "ro-crate-metadata.json",
"@type": "CreativeWork",
"about": {
"@id": "./"
},
"conformsTo": [
{
"@id": "https://w3id.org/ro/crate/1.1"
},
{
"@id": "https://w3id.org/workflowhub/workflow-ro-crate/1.0"
}
]
},
{
"@id": "main.nf",
"@type": [
"File",
"SoftwareSourceCode",
"ComputationalWorkflow"
],
"creator": [
{
"@id": "#phil.ewels@scilifelab.se"
}
],
"dateCreated": "",
"dateModified": "2026-02-25T10:00:00Z",
"dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/",
"keywords": [
"nf-core",
"nextflow",
"rna",
"rna-seq"
],
"license": [
"MIT"
],
"name": [
"nf-core/rnaseq"
],
"programmingLanguage": {
"@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow"
},
"sdPublisher": {
"@id": "https://nf-co.re/"
},
"url": [
"https://github.com/nf-core/rnaseq",
"https://nf-co.re/rnaseq/3.23.0/"
],
"version": [
"3.23.0"
]
},
{
"@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow",
"@type": "ComputerLanguage",
"identifier": {
"@id": "https://www.nextflow.io/"
},
"name": "Nextflow",
"url": {
"@id": "https://www.nextflow.io/"
},
"version": "!>=25.04.0"
},
{
"@id": "#0ad48f19-9581-4e1b-b10f-638ab0a48482",
"@type": "TestSuite",
"instance": [
{
"@id": "#d85e8f82-5b12-4ac5-842a-1621342f3e0b"
}
],
"mainEntity": {
"@id": "main.nf"
},
"name": "Test suite for nf-core/rnaseq"
},
{
"@id": "#d85e8f82-5b12-4ac5-842a-1621342f3e0b",
"@type": "TestInstance",
"name": "GitHub Actions workflow for testing nf-core/rnaseq",
"resource": "repos/nf-core/rnaseq/actions/workflows/nf-test.yml",
"runsOn": {
"@id": "https://w3id.org/ro/terms/test#GithubService"
},
"url": "https://api.github.com"
},
{
"@id": "https://w3id.org/ro/terms/test#GithubService",
"@type": "TestService",
"name": "Github Actions",
"url": {
"@id": "https://github.com"
}
},
{
"@id": "assets/",
"@type": "Dataset",
"description": "Additional files"
},
{
"@id": "conf/",
"@type": "Dataset",
"description": "Configuration files"
},
{
"@id": "docs/",
"@type": "Dataset",
"description": "Markdown files for documenting the pipeline"
},
{
"@id": "docs/images/",
"@type": "Dataset",
"description": "Images for the documentation files"
},
{
"@id": "modules/",
"@type": "Dataset",
"description": "Modules used by the pipeline"
},
{
"@id": "modules/nf-core/",
"@type": "Dataset",
"description": "nf-core modules"
},
{
"@id": "workflows/",
"@type": "Dataset",
"description": "Main pipeline workflows to be executed in main.nf"
},
{
"@id": "subworkflows/",
"@type": "Dataset",
"description": "Smaller subworkflows"
},
{
"@id": "nextflow.config",
"@type": "File",
"description": "Main Nextflow configuration file"
},
{
"@id": "README.md",
"@type": "File",
"description": "Basic pipeline usage information"
},
{
"@id": "nextflow_schema.json",
"@type": "File",
"description": "JSON schema for pipeline parameter specification"
},
{
"@id": "CHANGELOG.md",
"@type": "File",
"description": "Information on changes made to the pipeline"
},
{
"@id": "LICENSE",
"@type": "File",
"description": "The license - should be MIT"
},
{
"@id": "CODE_OF_CONDUCT.md",
"@type": "File",
"description": "The nf-core code of conduct"
},
{
"@id": "CITATIONS.md",
"@type": "File",
"description": "Citations needed when using the pipeline"
},
{
"@id": "modules.json",
"@type": "File",
"description": "Version information for modules from nf-core/modules"
},
{
"@id": "docs/usage.md",
"@type": "File",
"description": "Usage documentation"
},
{
"@id": "docs/output.md",
"@type": "File",
"description": "Output documentation"
},
{
"@id": ".nf-core.yml",
"@type": "File",
"description": "nf-core configuration file, configuring template features and linting rules"
},
{
"@id": ".pre-commit-config.yaml",
"@type": "File",
"description": "Configuration file for pre-commit hooks"
},
{
"@id": ".prettierignore",
"@type": "File",
"description": "Ignore file for prettier"
},
{
"@id": "https://nf-co.re/",
"@type": "Organization",
"name": "nf-core",
"url": "https://nf-co.re/"
},
{
"@id": "#phil.ewels@scilifelab.se",
"@type": "Person",
"email": "phil.ewels@scilifelab.se",
"name": "Phil Ewels"
}
]
}