Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Mermaid diagram #268

Merged
merged 14 commits into from
Feb 20, 2024
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Thank you to everyone else that has contributed by reporting bugs, enhancements
- [PR #264](https://github.com/nf-core/fetchngs/pull/264) - Remove synapse workflow from pipeline
- [PR #265](https://github.com/nf-core/fetchngs/pull/265) - Use "+" syntax for profiles to accumulate profiles in nf-test
- [PR #266](https://github.com/nf-core/fetchngs/pull/266) - Make .gitignore match template
- [PR #273](https://github.com/nf-core/fetchngs/pull/273) - Update subworkflows
- [PR #268](https://github.com/nf-core/fetchngs/pull/268) - Add mermaid diagram
- [PR #273](https://github.com/nf-core/fetchngs/pull/273) - Update utility subworkflows

### Software dependencies

Expand Down
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,36 @@

**nf-core/fetchngs** is a bioinformatics pipeline to fetch metadata and raw FastQ files from both public and private databases. At present, the pipeline supports SRA / ENA / DDBJ / GEO / Synapse ids (see [usage docs](https://nf-co.re/fetchngs/usage#introduction)).

```mermaid
flowchart LR
IDS("Input
File") --> SRA & GEO & ENA & DDBJ
subgraph SG_DBIDS[Database IDs]
SRA("SRA")
GEO("GEO")
ENA("ENA")
DDBJ("DDBJ")
end
subgraph SG_METADATA[Download Metadata]
SRA & GEO & ENA & DDBJ --> META("Get
Metadata")
META --> LINKS("Get
Download
Links")
end
subgraph SG_FETCH_FASTQ[Download FastQ]
LINKS --> |"(default)"| ASPERA("Aspera")
LINKS --> |--force_ftp_download| FTP("FTP")
maxulysse marked this conversation as resolved.
Show resolved Hide resolved
LINKS --> |--force_sra_tools_download| SRATOOLS("sra-tools")
end
subgraph SG_FASTQ[Pipeline Outputs]
ASPERA & FTP & SRATOOLS --> FASTQ("FastQ")
FASTQ --> SAMPLESHEET("Samplesheet")
end
LINKS --> |--skip_fastq_download| SAMPLESHEET

```

## Usage

> [!NOTE]
Expand Down
Loading