-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathro-crate-metadata.json
More file actions
346 lines (346 loc) · 20.8 KB
/
ro-crate-metadata.json
File metadata and controls
346 lines (346 loc) · 20.8 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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
{
"@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": "Stable",
"datePublished": "2026-03-14T09:55:43+00:00",
"description": "<h1>\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"docs/images/nf-core-stableexpression_logo_dark.png\">\n <img alt=\"nf-core/stableexpression\" src=\"docs/images/nf-core-stableexpression_logo_light.png\">\n </picture>\n</h1>\n\n[](https://github.com/codespaces/new/nf-core/stableexpression)\n[](https://github.com/nf-core/stableexpression/actions/workflows/nf-test.yml)\n[](https://github.com/nf-core/stableexpression/actions/workflows/linting.yml)[](https://nf-co.re/stableexpression/results)[](https://doi.org/10.5281/zenodo.XXXXXXX)\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://apptainer.org/)\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/stableexpression)\n\n[](https://nfcore.slack.com/channels/stableexpression)[](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/stableexpression** is a bioinformatics pipeline aiming to aggregate multiple count datasets for a specific species and find the most stable genes. The datasets can be either downloaded from public databases (EBI, NCBI) or provided directly by the user. Both RNA-seq and Microarray count datasets can be utilised.\n\n<p align=\"center\">\n <img title=\"Stableexpression Workflow\" src=\"docs/images/nf_core_stableexpression.metromap.png\" width=100%>\n</p>\n\nIt takes as main inputs :\n\n- a species name (mandatory)\n- keywords for Expression Atlas / GEO search (optional)\n- a CSV input file listing your own raw / normalised count datasets (optional).\n\n**Use cases**:\n\n- **find the most suitable genes as RT-qPCR reference genes for a specific species (and optionally specific conditions)**\n- download all Expression Atlas and / or NCBI GEO datasets for a species (and optionally keywords)\n\n## Pipeline overview\n\nThe pipeline is built using [Nextflow](https://www.nextflow.io/) and processes data using the following steps:\n\n#### 1. Get accessions from public databases\n\n- Get [Expression Atlas](https://www.ebi.ac.uk/gxa/home) dataset accessions corresponding to the provided species (and optionally keywords)\n This step is run by default but is optional. Set `--skip_fetch_eatlas_accessions` to skip it.\n- Get NBCI [GEO](https://www.ncbi.nlm.nih.gov/gds) **microarray** dataset accessions corresponding to the provided species (and optionally keywords)\n This is optional and **NOT** run by default. Set `--fetch_geo_accessions` to run it.\n\n#### 2. Download data (see [usage](./conf/usage.md#3-provide-your-own-accessions))\n\n- Download [Expression Atlas](https://www.ebi.ac.uk/gxa/home) data if any\n- Download NBCI [GEO](https://www.ncbi.nlm.nih.gov/gds) data if any\n\n> [!NOTE]\n> At this point, datasets downloaded from public databases are merged with datasets provided by the user using the `--datasets` parameter. See [usage](./conf/usage.md#4-use-your-own-expression-datasets) for more information about local datasets.\n\n#### 3. ID Mapping (see [usage](./conf/usage.md#5-custom-gene-id-mapping--metadata))\n\n- Gene IDs are cleaned\n- Map gene IDS to NCBI Entrez Gene IDS (or Ensembl IDs) for standardisation among datasets using [g:Profiler](https://biit.cs.ut.ee/gprofiler/gost) (run by default; optional)\n- Rare genes are filtered out\n\n#### 4. Sample filtering\n\nSamples that show too high ratios of zeros or missing values are removed from the analysis.\n\n#### 5. Normalisation of expression\n\n- Normalize RNAseq raw data using TPM (necessitates downloading the corresponding genome and computing transcript lengths) or CPM.\n- Perform quantile normalisation on each dataset separately using [scikit-learn](https://scikit-learn.org/stable/modules/generated/sklearn.preprocessing.quantile_transform.html)\n\n#### 6. Merge all data\n\nAll datasets are merged into one single dataframe.\n\n#### 7. Imputation of missing values\n\nMissing values are replaced by imputed values using a specific algorithm provided by [scikit-learn](https://scikit-learn.org/stable/modules/generated/sklearn.preprocessing.quantile_transform.html). The user can choose the method of imputation with the `--missing_value_imputer` parameter.\n\n#### 8. General statistics for each gene\n\nBase statistics are computed for each gene, platform-wide and for each platform (RNAseq and microarray).\n\n#### 9. Scoring\n\n- The whole list of genes is divided in multiple sections, based on their expression level.\n- Based on the coefficient of variation, a shortlist of candidates genes is extracted for each section.\n- Run optimised, scalable version of [Normfinder](https://www.moma.dk/software/normfinder)\n- Run optimised, scalable version of [Genorm](https://genomebiology.biomedcentral.com/articles/10.1186/gb-2002-3-7-research0034) (run by default; optional)\n- Compute stability scores for each candidate gene\n\n#### 10. Reporting\n\n- Result aggregation\n- Make [`MultiQC`](http://multiqc.info/) report\n- Prepare [Dash Plotly](https://dash.plotly.com/) app for further investigation of gene / sample counts\n\n## Test pipeline\n\nYou can test the execution of the pipeline locally with:\n\n```bash\nnextflow run nf-core/stableexpression -profile test,<docker/apptainer/conda/micromamba/...>\n```\n\n## Basic 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\nTo search the most stable genes in a species considering all public datasets, simply run:\n\n```bash\nnextflow run nf-core/stableexpression \\\n -profile <PROFILE (examples: docker / apptainer / conda / micromamba)> \\\n --species <SPECIES (examples: arabidopsis_thaliana / \"drosophila melanogaster\")> \\\n --outdir <OUTDIR (example: ./results)> \\\n -resume\n```\n\n## More advanced usage\n\nFor more specific scenarios, like:\n\n- **fetching only specific conditions**\n- **using your own expression dataset(s)**\n\nplease refer to the [usage documentation](https://nf-co.re/stableexpression/usage).\n\n## Resource allocation\n\nFor setting pipeline CPU / memory usage, see [here](./docs/configuration.md).\n\n## Profiles\n\nSee [here](https://nf-co.re/stableexpression/usage#profiles) for more information about profiles.\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/stableexpression/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/stableexpression/output).\n\n## Support us\n\nIf you like nf-core/stableexpression, please make sure you give it a star on GitHub!\n\n[](https://github.com/nf-core/stableexpression)\n\n## Credits\n\nnf-core/stableexpression was originally written by Olivier Coen.\n\nWe thank the following people for their assistance in the development of this pipeline:\n\n- R\u00e9my Costa\n- Shaheen Acheche\n- Janine Soares\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 `#stableexpression` channel](https://nfcore.slack.com/channels/stableexpression) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\n<!-- TODO nf-core: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. -->\n<!-- If you use nf-core/stableexpression for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->\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": "bin/"
},
{
"@id": "conf/"
},
{
"@id": "docs/"
},
{
"@id": "docs/images/"
},
{
"@id": "modules/"
},
{
"@id": "modules/local/"
},
{
"@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/stableexpression",
"license": "MIT",
"mainEntity": {
"@id": "main.nf"
},
"mentions": [
{
"@id": "#6aa6a373-9bb0-4502-a8f4-2fce1f6296ee"
}
],
"name": "nf-core/stableexpression"
},
{
"@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": "https://orcid.org/0000-0003-3387-1040"
}
],
"dateCreated": "",
"dateModified": "2026-03-14T10:55:43Z",
"dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/",
"keywords": [
"nf-core",
"nextflow",
"expression",
"housekeeping-genes",
"qpcr-analysis"
],
"license": [
"MIT"
],
"maintainer": [
{
"@id": "https://orcid.org/0000-0003-3387-1040"
}
],
"name": [
"nf-core/stableexpression"
],
"programmingLanguage": {
"@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow"
},
"sdPublisher": {
"@id": "https://nf-co.re/"
},
"url": [
"https://github.com/nf-core/stableexpression",
"https://nf-co.re/stableexpression/1.0.0/"
],
"version": [
"1.0.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": "#6aa6a373-9bb0-4502-a8f4-2fce1f6296ee",
"@type": "TestSuite",
"instance": [
{
"@id": "#2fa3572f-894b-4153-a0a8-dca4386f0cea"
}
],
"mainEntity": {
"@id": "main.nf"
},
"name": "Test suite for nf-core/stableexpression"
},
{
"@id": "#2fa3572f-894b-4153-a0a8-dca4386f0cea",
"@type": "TestInstance",
"name": "GitHub Actions workflow for testing nf-core/stableexpression",
"resource": "repos/nf-core/stableexpression/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": "bin/",
"@type": "Dataset",
"description": "Scripts that must be callable from a pipeline process"
},
{
"@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/local/",
"@type": "Dataset",
"description": "Pipeline-specific modules"
},
{
"@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": "https://orcid.org/0000-0003-3387-1040",
"@type": "Person",
"email": "coen.olivier@gmail.com",
"name": "Olivier Coen"
}
]
}