Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 6 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.7%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: lescai-teaching
- License: mit
- Language: Nextflow
- Default Branch: master
- Size: 133 MB
Statistics
- Stars: 1
- Watchers: 0
- Forks: 5
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
Introduction
Eduomics is a bioinformatics pipeline designed for educational purposes that simulates realistic genomic and transcriptomic datasets. The pipeline creates controlled, validated datasets that can be used to teach bioinformatics analysis workflows, variant calling, and differential gene expression analysis.
The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!
Functionality Overview
A graphical view of the pipeline can be seen below.
Pipeline Logic and Assumptions
Core Educational Philosophy
The eduomics pipeline is built on the principle that learning bioinformatics requires realistic, well-characterized datasets where the "ground truth" is known. Traditional educational approaches often use oversimplified toy datasets or real datasets where the biological truth is unknown, making it difficult for students to validate their analytical approaches.
Pipeline Architecture
The pipeline operates on two main simulation modes:
1. DNA Variant Simulation Mode
- Purpose: Teaches variant calling and clinical interpretation workflows
- Logic: Injects known pathogenic variants into specific genomic regions and generates realistic sequencing reads
- Educational Value: Students can practice variant calling knowing exactly which variants should be detected
2. RNA Differential Expression Simulation Mode
- Purpose: Teaches RNA-seq analysis and differential expression workflows
- Logic: Creates realistic count matrices with known differential expression patterns and generates corresponding RNA-seq reads
- Educational Value: Students can practice RNA-seq analysis with known differentially expressed genes
Key Assumptions
- Chromosome-specific Analysis: The pipeline focuses on single chromosomes (typically chr22) to reduce computational requirements while maintaining biological realism
- Capture-based Sequencing: For DNA simulations, the pipeline assumes exome or targeted sequencing using capture regions
- Paired-end Sequencing: All simulations generate paired-end reads reflecting modern sequencing practices
- Human Reference: The pipeline is designed for human genomic data using standard reference genomes
- Educational Context: All simulations include AI-generated educational scenarios to provide biological context
Schematic Pipeline Workflow Overview
```mermaid graph TD A[Input Samplesheet] --> B{Data Type?} B -->|DNA| C[DNA Simulation Branch] B -->|RNA| D[RNA Simulation Branch]
C --> C1[Subset References to Target Regions]
C1 --> C2[Extract Pathogenic Variants]
C2 --> C3[Generate Sequencing Profile]
C3 --> C4[Simulate DNA Reads with Variants]
C4 --> C5[Validate Variant Detection]
C5 --> C6[Generate AI Educational Scenario]
D --> D1[Subset Transcriptome References]
D1 --> D2[Create Count Matrices]
D2 --> D3[Simulate RNA-seq Reads]
D3 --> D4[Quantify Expression]
D4 --> D5[Perform Differential Expression Analysis]
D5 --> D6[Validate Results & Generate Scenario]
C6 --> E[Organized Output with References]
D6 --> E
```
Main Features
- 🧬 Realistic DNA Simulations: Generate sequencing data with known pathogenic variants for variant calling practice
- 🧮 RNA-seq Simulations: Create differential expression datasets with known ground truth
- 🤖 AI-Powered Scenarios: Automatically generate educational contexts and case studies
- 📚 Educational Focus: Designed specifically for teaching bioinformatics workflows
- 🔬 Validation Built-in: Ensures simulated data meets quality standards for educational use
- 📦 Complete Packages: Provides both simulated data and reference materials needed for analysis
- ⚡ Scalable: Configurable coverage, sample sizes, and complexity levels
Documentation
The eduomics pipeline comes with documentation about the pipeline usage and output.
Usage
[!NOTE] If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with
-profile testbefore running the workflow on actual data.
First, prepare a samplesheet with your simulation parameters that looks as follows:
samplesheet.csv:
csv
id,type,chromosome,coverage,capture,reps,groups,simthreshold
dna_simulation_1,dna,chr22,100,https://example.com/capture.bed,1,2,0.3
rna_simulation_1,rna,chr22,30,,3,2,0.3
Each row represents a simulation to be performed. See the usage documentation for detailed parameter explanations.
Now, you can run the pipeline using:
bash
nextflow run eduomics \
-profile <docker/singularity/.../institute> \
--input samplesheet.csv \
--genome GATK.GRCh38 \
--outdir <OUTDIR>
[!WARNING] Please provide pipeline parameters via the CLI or Nextflow
-params-fileoption. Custom config files including those provided by the-cNextflow option can be used to provide any configuration except for parameters; see docs.
For more details and further functionality, please refer to the usage documentation.
Pipeline outputs
The pipeline generates organized educational datasets with the following structure:
- DNA Simulations: Simulated FASTQ files with known variants, reference materials, and educational scenarios
- RNA Simulations: Simulated RNA-seq data with known differential expression, analysis results, and educational contexts
- Reference Bundles: All necessary reference files for downstream analysis
- Educational Materials: AI-generated scenarios and validation results
For detailed information about the output files and reports, please refer to the output documentation.
Educational Use Cases
For Instructors
- Create custom datasets for specific learning objectives
- Generate multiple scenarios with different complexity levels
- Provide students with realistic data where ground truth is known
- Validate student analyses against known results
For Students
- Practice variant calling with datasets containing known pathogenic variants
- Learn RNA-seq analysis with controlled differential expression patterns
- Understand the relationship between sequencing parameters and data quality
- Develop skills in interpreting bioinformatics results
For Workshops and Training
- Generate datasets tailored to workshop duration and participant skill level
- Create reproducible training materials
- Provide consistent datasets across multiple training sessions
Credits
Eduomics was originally written by Mariangela Santorsola, Lorenzo Sola, Davide Bagordo, Simone Carpanzano, Francesco Lescai.
Contributions and Support
If you would like to contribute to this pipeline, please see the contributing guidelines.
For further information or help, don't hesitate to get in touch with the development team.
Citations
If you use lescai-teaching/eduomics for your analysis, please cite it using the following doi: 10.5281/zenodo.15835070
An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.
Owner
- Name: Prof. Lescai Teaching Material
- Login: lescai-teaching
- Kind: organization
- Location: Italy
- Website: https://elearning.unipv.it/course/view.php?id=13
- Repositories: 2
- Profile: https://github.com/lescai-teaching
University of Pavia - Bioinformatics Teaching for Life Sciences - Prof. Francesco Lescai
Citation (CITATIONS.md)
# nf-core/eduomics: Citations ## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/) > Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031. ## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/) > Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311. ## Pipeline tools ## Software packaging/containerisation tools - [Anaconda](https://anaconda.com) > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web. - [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/) > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506. - [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/) > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671. - [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241) > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. doi: 10.5555/2600239.2600241. - [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/) > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.
GitHub Events
Total
- Issues event: 34
- Watch event: 1
- Delete event: 5
- Issue comment event: 5
- Push event: 72
- Pull request review comment event: 42
- Pull request review event: 110
- Pull request event: 84
- Fork event: 12
- Create event: 8
Last Year
- Issues event: 34
- Watch event: 1
- Delete event: 5
- Issue comment event: 5
- Push event: 72
- Pull request review comment event: 42
- Pull request review event: 110
- Pull request event: 84
- Fork event: 12
- Create event: 8
Dependencies
- actions/upload-artifact v4 composite
- octokit/request-action v2.x composite
- seqeralabs/action-tower-launch v2 composite
- actions/upload-artifact v4 composite
- seqeralabs/action-tower-launch v2 composite
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- conda-incubator/setup-miniconda a4260408e20b96e80095f42ff7f1a15b27dd94ca composite
- eWaterCycle/setup-apptainer main composite
- jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
- nf-core/setup-nextflow v2 composite
- actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
- actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
- eWaterCycle/setup-apptainer 4bb22c52d4f63406c49e94c804632975787312b3 composite
- jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
- nf-core/setup-nextflow v2 composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
- peter-evans/create-or-update-comment 71345be0265236311c031f5c7866368bd1eff043 composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
- actions/upload-artifact b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 composite
- nf-core/setup-nextflow v2 composite
- pietrobolcato/action-read-yaml 1.1.0 composite
- dawidd6/action-download-artifact 20319c5641d495c8a52e688b7dc5fada6c3a9fbc composite
- marocchino/sticky-pull-request-comment 331f8f5b4215f0445d3c07b4967662a32a2d3e31 composite
- rzr/fediverse-action master composite
- zentered/bluesky-post-action 80dbe0a7697de18c15ad22f4619919ceb5ccf597 composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- nichmor/minimal-read-yaml v0.0.2 composite
- nextflow 24.10.5.*
- nf-core 3.2.0.*
- nf-test 0.9.2.*
- pip
- bioconductor-biostrings 2.68.1.*
- r-tidyverse 2.0.0.*
- bash 5.2.21.*
- python 3.9.*
- bioconductor-dose 4.0.0.*
- simuscop 1.1.2.*
- simuscop 1.2.0.*
- bedtools 2.31.1.*
- htslib 1.21.*
- bioconductor-biostrings 2.68.1.*
- r-tidyverse 2.0.0.*
- bioconductor-annotationdbi 1.62.2.*
- bioconductor-biostrings 2.68.1.*
- bioconductor-clusterprofiler 4.8.1.*
- bioconductor-org.hs.eg.db 3.17.0.*
- bioconductor-rtracklayer 1.60.0.*
- r-httr 1.4.7.*
- r-igraph 1.5.1.*
- r-jsonlite 1.8.7.*
- r-matrix 1.6.5.*
- r-tidyverse 2.0.0.*
- htslib 1.20.*
- tabix 1.11.*
- bwa 0.7.18.*
- bwa 0.7.18.*
- htslib 1.20.0.*
- samtools 1.20.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- htslib 1.19.1.*
- samtools 1.19.2.*
- gatk4 4.6.1.0.*
- gcnvkernel 0.9.*
- htslib 1.21.*
- samtools 1.21.*
- htslib 1.21.*
- samtools 1.21.*
- htslib 1.21.*
- samtools 1.21.*
- wgsim 1.0.*