Skip to content
Merged

Dev #158

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
- uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5

- name: Set up Python 3.14
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
Expand All @@ -28,7 +28,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out pipeline code
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5

- name: Install Nextflow
uses: nf-core/setup-nextflow@v2
Expand Down Expand Up @@ -71,7 +71,7 @@ jobs:

- name: Upload linting log file artifact
if: ${{ always() }}
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5
with:
name: linting-logs
path: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/nf-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:
- isMain: false
profile: "singularity"
NXF_VER:
- "24.10.5"
- "25.10.0"
- "latest-everything"
env:
NXF_ANSI_LOG: false
Expand Down
2 changes: 1 addition & 1 deletion .nf-core.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
repository_type: pipeline

nf_core_version: 3.4.1
nf_core_version: 3.5.2

lint: {}

Expand Down
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ testing*
bin/
.nf-test/
ro-crate-metadata.json
modules/nf-core/
subworkflows/nf-core/
4 changes: 4 additions & 0 deletions assets/multiqc_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ report_section_order:
bcftools:
order: 100

custom_logo: "nf-core-bactmap_logo_light.png"
custom_logo_url: https://nf-co.re/bactmap
custom_logo_title: "nf-core/bactmap"

# List of run modules
run_modules:
- fastqc
Expand Down
Binary file modified assets/nf-core-bactmap_logo_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
344 changes: 194 additions & 150 deletions conf/modules.config

Large diffs are not rendered by default.

Binary file modified docs/images/nf-core-bactmap_logo_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/nf-core-bactmap_logo_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 24 additions & 14 deletions docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
- [SAMtools stats](#samtools-stats) - Statistics from mapping
- [FreeBayes](#freebayes) - Variant calling for Illumina reads
- [Clair3](#clair3) - Variant calling for Nanopore reads
- [BCFtools filter](#bcftools-filter) - Filtering of variants
- [BCFtools filter](#bcftools-filter) - Filtering of Illumina variants
- [BCFtools norm](#bcftools-norm) - Normalisation of ONT variants
- [BCFtools stats](#bcftools-stats) - Statistics from variant calling
- [BCFtools consensus](#bcftools-consensus) - Convert filtered bcf to pseudogenome fasta
- [seqtk](#seqtk) - Summarise mapping statistics
Expand Down Expand Up @@ -313,23 +314,25 @@ It is used with nf-core/bactmap to map short reads to the reference genome.
</details>

:::info
While there is a dedicated section in the MultiQC HTML for BWA-MEM2, these values are not displayed by default in the General Stats table. Rather, alignment statistics to host genome is reported via samtools stats module in MultiQC report.
While there is a dedicated section in the MultiQC HTML for BWA-MEM2, these values are not displayed by default in the General Stats table. Rather, alignment statistics to host genome is reported via samtools stats module in MultiQC report. By default the bam files created are not saved since sorted bam files are produced in the next step
:::

### minimap2

[minimap2](https://github.com/lh3/minimap2) is an alignment tool suited to mapping long reads to reference sequences.

It is used with nf-core/bactmap to map short reads to the reference genome.
It is used with nf-core/bactmap to map long reads to the reference genome.

<details markdown="1">
<summary>Output files</summary>

- `minimap2/`
- `build/`
- `*.mmi2`: minimap2 indices of reference genome.

</details>
- `align/`
- `<sample_id>.bam`: BAM file containing reads that aligned against the user-supplied reference genome as well as unmapped reads
- `<sample_id>.bam.bai`: Index file for the BAM file
</details>

:::info
minimap2 is not yet supported as a module in MultiQC and therefore there is no dedicated section in the MultiQC HTML. Rather, alignment statistics to host genome is reported via samtools stats module in MultiQC report.
Expand Down Expand Up @@ -373,9 +376,7 @@ FreeBayes is a haplotype-based variant detector designed to find SNPs, indels, a
<summary>Output files</summary>

- `freebayes/`
- `variants/`
- `<sample_id>.vcf.gz`: VCF file containing variants
- `<sample_id>.vcf.gz.tbi`: Index file for the VCF file
- `<sample_id>.vcf.gz`: VCF file containing variants

</details>

Expand All @@ -387,10 +388,7 @@ Clair3 is a variant caller for long-read data. It is used with nf-core/bactmap t
<summary>Output files</summary>

- `clair3/`
- `variants/`
- `<sample_id>.vcf.gz`: VCF file containing variants
- `<sample_id>.vcf.gz.tbi`: Index file for the VCF file
- `<sample_id>.vcf.gz.stats`: Statistics file for the VCF
- `<sample_id>.vcf.gz`: VCF file containing variants

</details>

Expand All @@ -401,8 +399,20 @@ The `BCFtools` software is used to call and filter variants found within the bam
<details markdown="1">
<summary>Output files</summary>

- `variants/filtered`
- `<sample_id>.vcf.gz` filtered vcf files containing variants
- `filtered_variants`
- `<sample_id>.filtered.vcf.gz` filtered vcf files containing variants

</details>

### BCFtools norm

`BCFtools` norm is used to normalize the variant calls from ONT data.

<details markdown="1">
<summary>Output files</summary>

- `filtered_variants`
- `<sample_id>.filtered.vcf.gz` filtered vcf files containing variants

</details>

Expand Down
5 changes: 4 additions & 1 deletion main.nf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,10 @@ workflow {
params.monochrome_logs,
args,
params.outdir,
params.input
params.input,
params.help,
params.help_full,
params.show_hidden
)

//
Expand Down
71 changes: 43 additions & 28 deletions modules.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,47 @@
},
"bcftools/filter": {
"branch": "master",
"git_sha": "f17049e03697726ace7499d2fe342f892594f6f3",
"git_sha": "6383d8fe58f9498eecd5aa303e71a4a932d1e9f6",
"installed_by": ["modules"]
},
"bcftools/index": {
"branch": "master",
"git_sha": "f17049e03697726ace7499d2fe342f892594f6f3",
"git_sha": "6383d8fe58f9498eecd5aa303e71a4a932d1e9f6",
"installed_by": ["bam_variant_calling_sort_freebayes_bcftools"]
},
"bcftools/norm": {
"branch": "master",
"git_sha": "6383d8fe58f9498eecd5aa303e71a4a932d1e9f6",
"installed_by": ["modules"]
},
"bcftools/query": {
"branch": "master",
"git_sha": "f17049e03697726ace7499d2fe342f892594f6f3",
"git_sha": "6383d8fe58f9498eecd5aa303e71a4a932d1e9f6",
"installed_by": ["modules"]
},
"bcftools/sort": {
"branch": "master",
"git_sha": "f17049e03697726ace7499d2fe342f892594f6f3",
"git_sha": "6383d8fe58f9498eecd5aa303e71a4a932d1e9f6",
"installed_by": ["bam_variant_calling_sort_freebayes_bcftools"]
},
"bcftools/stats": {
"branch": "master",
"git_sha": "f17049e03697726ace7499d2fe342f892594f6f3",
"git_sha": "6383d8fe58f9498eecd5aa303e71a4a932d1e9f6",
"installed_by": ["modules"]
},
"bcftools/view": {
"branch": "master",
"git_sha": "6383d8fe58f9498eecd5aa303e71a4a932d1e9f6",
"installed_by": ["modules"]
},
"bedtools/subtract": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "88d43dad73a675e66bff49ebb57fe657a5909018",
"installed_by": ["modules"]
},
"bowtie2/align": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "e753770db613ce014b3c4bc94f6cba443427b726",
"installed_by": ["modules"]
},
"bowtie2/build": {
Expand All @@ -52,17 +62,17 @@
},
"bwamem2/index": {
"branch": "master",
"git_sha": "b2902040b9cb9b7b32b62400f1c024a709bd4812",
"git_sha": "d86336f3e7ae0d5f76c67b0859409769cfeb2af2",
"installed_by": ["modules"]
},
"bwamem2/mem": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "d86336f3e7ae0d5f76c67b0859409769cfeb2af2",
"installed_by": ["modules"]
},
"cat/fastq": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "cf735af4433f2dc8e410f67012dff824ef9990eb",
"installed_by": ["modules"]
},
"falco": {
Expand All @@ -72,12 +82,12 @@
},
"fastp": {
"branch": "master",
"git_sha": "c8be52dba1166c678e74cda9c3a3c221635c8bb1",
"git_sha": "b8f1de0ac853ae5b56c63450d47438f899c553d0",
"installed_by": ["modules"]
},
"fastqc": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "5bdb098216aaf5df9c3b6343e6204cd932503c16",
"installed_by": ["modules"]
},
"fastqscan": {
Expand All @@ -97,22 +107,22 @@
},
"gunzip": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "96c57dfd98a0641886a67bd449fe33ee2ec0e374",
"installed_by": ["modules"]
},
"minimap2/align": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "e753770db613ce014b3c4bc94f6cba443427b726",
"installed_by": ["modules"]
},
"minimap2/index": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "e753770db613ce014b3c4bc94f6cba443427b726",
"installed_by": ["modules"]
},
"multiqc": {
"branch": "master",
"git_sha": "e10b76ca0c66213581bec2833e30d31f239dec0b",
"git_sha": "80cba9452fb1e9bb79884976fa1ca0e671949aa2",
"installed_by": ["modules"]
},
"nanoq": {
Expand All @@ -127,17 +137,17 @@
},
"porechop/porechop": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "e753770db613ce014b3c4bc94f6cba443427b726",
"installed_by": ["modules"]
},
"samtools/faidx": {
"branch": "master",
"git_sha": "c8be52dba1166c678e74cda9c3a3c221635c8bb1",
"git_sha": "9a48bce39a67e2cb34b8f125fc1d50f0ad98b616",
"installed_by": ["modules"]
},
"samtools/flagstat": {
"branch": "master",
"git_sha": "c8be52dba1166c678e74cda9c3a3c221635c8bb1",
"git_sha": "e334e12a1e985adc5ffc3fc78a68be1de711de45",
"installed_by": ["bam_stats_samtools"]
},
"samtools/idxstats": {
Expand All @@ -148,21 +158,21 @@
"samtools/index": {
"branch": "master",
"git_sha": "c8be52dba1166c678e74cda9c3a3c221635c8bb1",
"installed_by": ["modules"]
"installed_by": ["bam_sort_stats_samtools", "modules"]
},
"samtools/sort": {
"branch": "master",
"git_sha": "c8be52dba1166c678e74cda9c3a3c221635c8bb1",
"installed_by": ["modules"]
"git_sha": "5cb9a8694da0a0e550921636bb60bc8c56445fd7",
"installed_by": ["bam_sort_stats_samtools", "modules"]
},
"samtools/stats": {
"branch": "master",
"git_sha": "c8be52dba1166c678e74cda9c3a3c221635c8bb1",
"git_sha": "fe93fde0845f907fc91ad7cc7d797930408824df",
"installed_by": ["bam_stats_samtools", "modules"]
},
"seqtk/comp": {
"branch": "master",
"git_sha": "41dfa3f7c0ffabb96a6a813fe321c6d1cc5b6e46",
"git_sha": "a46713779030a5f508117080cbf4b693dd4c6e33",
"installed_by": ["modules"]
},
"snpsites": {
Expand All @@ -174,24 +184,29 @@
},
"subworkflows": {
"nf-core": {
"bam_stats_samtools": {
"bam_sort_stats_samtools": {
"branch": "master",
"git_sha": "c8be52dba1166c678e74cda9c3a3c221635c8bb1",
"git_sha": "eed5d14302a6c9070dcc25feeab707a27a4b3254",
"installed_by": ["subworkflows"]
},
"bam_stats_samtools": {
"branch": "master",
"git_sha": "eed5d14302a6c9070dcc25feeab707a27a4b3254",
"installed_by": ["bam_sort_stats_samtools", "subworkflows"]
},
"utils_nextflow_pipeline": {
"branch": "master",
"git_sha": "05954dab2ff481bcb999f24455da29a5828af08d",
"installed_by": ["subworkflows"]
},
"utils_nfcore_pipeline": {
"branch": "master",
"git_sha": "05954dab2ff481bcb999f24455da29a5828af08d",
"git_sha": "65f5e638d901a51534c68fd5c1c19e8112fb4df1",
"installed_by": ["subworkflows"]
},
"utils_nfschema_plugin": {
"branch": "master",
"git_sha": "dcd088f483cede0c3df4034d405126f05a764cc7",
"git_sha": "fdc08b8b1ae74f56686ce21f7ea11ad11990ce57",
"installed_by": ["subworkflows"]
}
}
Expand Down
2 changes: 1 addition & 1 deletion modules/local/clair3/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ channels:
- conda-forge
- bioconda
dependencies:
- "bioconda::clair3=1.0.10"
- "bioconda::clair3=1.2.0"
Loading