theiagen / public_health_bioinformatics

Bioinformatics workflows for genomic characterization, submission preparation, and genomic epidemiology of pathogens of public health concern.
GNU General Public License v3.0
33 stars 15 forks source link

[FastP & FastQC] output FastP and FastQC reports & output name changes #378

Closed sage-wright closed 3 months ago

sage-wright commented 4 months ago

This PR closes #336.

🗑️ This dev branch should be deleted after merging to main.

:brain: Aim, Context and Functionality

:hammer_and_wrench: Impacted Workflows/Tasks & Changes Being Made

This will affect the behavior of the workflow(s) even if users don’t change any workflow inputs relative to the last version : No

Running this workflow on different occasions could result in different results, e.g. due to use of a live database, "latest" docker image, or stochastic data processing : No

:clipboard: Workflow/Task Step Changes

🔄 Data Processing

No data processing changes

➡️ Inputs

⬅️ Outputs

Old New Where
num_reads_raw1 fastq_scan_num_reads_raw1 Freyja_FASTQ, TheiaCoV_ClearLabs, TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
num_reads_raw2 fastq_scan_num_reads_raw2 Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE, TheiaProk_Illumina_PE
num_reads_raw fastq_scan_num_reads_raw1 TheiaCoV_Illumina_SE
num_reads_raw_pairs fastq_scan_num_reads_raw_pairs Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE, TheiaProk_Illumina_PE
num_reads_clean1 fastq_scan_num_reads_clean1 Freyja_FASTQ, TheiaCoV_ClearLabs, TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
num_reads_clean2 fastq_scan_num_reads_clean2 Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE, TheiaProk_Illumina_PE
num_reads_clean fastq_scan_num_reads_clean1 TheiaCoV_Illumina_SE
num_reads_clean_pairs fastq_scan_num_reads_clean_pairs Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE, TheiaProk_Illumina_PE
raw_read_screen read_screen_raw TheiaCoV_Illumina_PE, TheiaCoV_Illumina_SE, TheiaCoV_ONT, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE, TheiaProk_ONT
clean_read_screen read_screen_clean TheiaCoV_Illumina_PE, TheiaCoV_Illumina_SE, TheiaCoV_ONT, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE, TheiaProk_ONT
-- Int? fastqc_num_reads_raw1 TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
-- Int? fastqc_num_reads_raw2 TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE
Int? fastqc_num_reads_raw Int? fastqc_num_reads_raw1 TheiaCoV_Illumina_SE
-- String? fastqc_num_reads_raw_pairs TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE
-- Int? fastqc_num_reads_clean1 TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
-- Int? fastqc_num_reads_clean2 TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE
Int? fastqc_num_reads_clean Int? fastqc_num_reads_clean1 TheiaCoV_Illumina_SE
-- String? fastqc_num_reads_clean_pairs TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE
-- File? fastqc_raw1_html TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
-- File? fastqc_raw2_html TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE
File? fastqc_raw_html File? fastqc_raw1_html read_QC_trim_SE, TheiaCoV_Illumina_SE
-- File? fastqc_clean1_html TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
-- File? fastqc_clean2_html TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE
File? fastqc_clean_html File? fastqc_clean1_html read_QC_trim_SE, TheiaCoV_Illumina_SE
-- String? fastqc_version TheiaCoV_Illumina_PE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE
-- String? fastqc_docker Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaCoV_Illumina_SE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
-- String? trimmomatic_docker read_QC_trim_SE, Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaCoV_Illumina_SE, TheiaEuk_Illumina_PE, TheiaProk_Illumina_PE, TheiaProk_Illumina_SE
-- String? fastp_version Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaCoV_Illumina_SE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE
-- File? fastp_html_report read_QC_trim_SE, read_QC_trim_PE, Freyja_FASTQ, TheiaCoV_Illumina_PE, TheiaCoV_Illumina_SE, TheiaEuk_Illumina_PE, TheiaMeta_Illumina_PE, TheiaProk_Illumina_SE, TheiaProk_Illumina_SE
Int? fastq_scan_raw_number_reads Int? fastq_scan_raw1 read_QC_trim_SE (mimics read_QC_trim_PE now)
Int? fastq_scan_clean_number_reads Int? fastq_scan_clean1 read_QC_trim_SE (mimics read_QC_trim_PE now)
Int? fastqc_raw_number_reads Int? fastqc_raw1 read_QC_trim_SE (mimics read_QC_trim_PE now)
Int? fastqc_clean_number_reads Int? fastqc_clean1 read_QC_trim_SE (mimics read_QC_trim_PE now)

:test_tube: Testing

Test Dataset

Commandline Testing with MiniWDL or Cromwell (optional)

Terra Testing

Suggested Scenarios for Reviewer to Test

Theiagen Version Release Testing (optional)

:microscope: Final Developer Checklist

🎯 Reviewer Checklist

🗂️ Associated Documentation (to be completed by Theiagen developer)

cimendes commented 3 months ago

Inputs:

cimendes commented 3 months ago

Freyja_FASTQ

TheiaCoV_ClearLabs

TheiaCoV_Illumina_PE

TheiaCoV_Illumina_SE

cimendes commented 3 months ago

TheiaEuk_Illumina_PE

TheiaMeta_Illumina_PE

cimendes commented 3 months ago

TheiaProk_Illumina_PE

TheiaProk_Illumina_SE

cimendes commented 3 months ago

All inputs and outputs have been verified as present in all the affected workflows. As a bonus, the trimmomatic_docker was also exposed in all the workflows.

Code changes look good! 🌟 Approving!