Running PHoeNIx

You should have already set up your config file to make sure nextflow knows how to run the programs within PHoeNIx . If you haven't please review the config set up portion of the install page.

Inputs

PHoeNIx currently only runs on Illumina paired-end reads. Multiple samples can be run using a samplesheet.csv file

nextflow run CDCgov/phoenix -profile <docker/singularity/conda/institute> --input samplesheet.csv

Samplesheet Input

You will need to create a samplesheet with information about the samples you would like to analyze before running the pipeline. Use the --input parameter to specify its location. It has to be a comma-separated file (csv) with at least 3 columns, and a header row as shown in the examples below. DO NOT HAVE ANY SPACES IN THIS FILE. Do make sure the paths are full paths and not relative. For best results use the automated samplesheet creation scripts described in the automated section below.

--input '[path to samplesheet file]'

Full Samplesheet

The samplesheet can have as many columns as you desire, however, there is a strict requirement for the first 3 columns to match those defined in the table below.

A final samplesheet file consisting of paired-end data may look something like the one below.

sample,fastq_1,fastq_2
SAMPLE_1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz
SAMPLE_2,AEG588A2_S2_L002_R1_001.fastq.gz,AEG588A2_S2_L002_R2_001.fastq.gz
SAMPLE_3,AEG588A3_S3_L002_R1_001.fastq.gz,AEG588A3_S3_L002_R2_001.fastq.gz

Column	Description
sample	Custom sample name. This entry will be identical for multiple sequencing libraries/runs from the same sample. Spaces in sample names are automatically converted to underscores (_).
fastq_1	Full path to FastQ file for Illumina short reads 1. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz".
fastq_2	Full path to FastQ file for Illumina short reads 2. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz".

An example samplesheet has been provided with the pipeline and can be used for testing.

Samplesheet Creation - Automated

A script is available to create a samplesheet from a directory of fastq files. The script will search 1 directory deep and attempt to determine sample id names and pairing/multilane information and will automatically create a samplesheet.

- Please review the samplesheet for accuracy before using it in the pipeline.

phoenix/bin/create_samplesheet.sh <directory of fastq files> > samplesheet.csv

Outputs

The output of PHoeNIx is structured like the following:

📦results
┣ 📂2021GO-01830
┃ ┣ 📂ANI
┃ ┃ ┣ 📂mash_sketch
┃ ┃ ┃ ┣ 📜2021GO-01830.mash_stats
┃ ┃ ┃ ┗ 📜2021GO-01830.msh
┃ ┃ ┗ 📜2021GO-01830.ani.txt
┃ ┣ 📂Assembly
┃ ┃ ┣ 📜2021GO-01830.assembly.gfa.gz
┃ ┃ ┣ 📜2021GO-01830.contigs.fa.gz
┃ ┃ ┣ 📜2021GO-01830.scaffolds.fa.gz
┃ ┃ ┗ 📜2021GO-01830.spades.log
┃ ┣ 📂BUSCO
┃ ┃ ┣ 📜2021GO-01830-auto-busco.batch_summary.txt
┃ ┃ ┣ 📜short_summary.generic.bacteria_odb10.2021GO-01830.scaffolds.fa.json
┃ ┃ ┣ 📜short_summary.generic.bacteria_odb10.2021GO-01830.scaffolds.fa.txt
┃ ┃ ┣ 📜short_summary.specific.enterobacterales_odb10.2021GO-01830.scaffolds.fa.json
┃ ┃ ┗ 📜short_summary.specific.enterobacterales_odb10.2021GO-01830.scaffolds.fa.txt
┃ ┣ 📂assemblies500plus
┃ ┃ ┣ 📜2021GO-01830.formatted.scaffolds.fa.gz
┃ ┃ ┗ 📜2021GO-01830.reformat.log
┃ ┣ 📂fastp_singles
┃ ┃ ┣ 📜2021GO-01830.fastp.html
┃ ┃ ┣ 📜2021GO-01830.fastp.json
┃ ┃ ┣ 📜2021GO-01830_1.trim.fastq.gz
┃ ┃ ┗ 📜2021GO-01830_2.trim.fastq.gz
┃ ┣ 📂fastp_trimd
┃ ┃ ┣ 📜2021GO-01830.fastp.html
┃ ┃ ┣ 📜2021GO-01830.fastp.json
┃ ┃ ┣ 📜2021GO-01830.merged.fastq.gz
┃ ┃ ┣ 📜2021GO-01830_1.fail.fastq.gz
┃ ┃ ┣ 📜2021GO-01830_1.trim.fastq.gz
┃ ┃ ┣ 📜2021GO-01830_2.fail.fastq.gz
┃ ┃ ┗ 📜2021GO-01830_2.trim.fastq.gz
┃ ┣ 📂fastqc_stats
┃ ┃ ┣ 📜2021GO-01830_1_fastqc.html
┃ ┃ ┣ 📜2021GO-01830_1_fastqc.zip
┃ ┃ ┣ 📜2021GO-01830_2_fastqc.html
┃ ┃ ┗ 📜2021GO-01830_2_fastqc.zip
┃ ┣ 📂gamma_ar
┃ ┃ ┣ 📜2021GO-01830.gamma
┃ ┃ ┗ 📜2021GO-01830.psl
┃ ┣ 📂gamma_prep
┃ ┃ ┗ 📜2021GO-01830.formatted.scaffolds.fa
┃ ┣ 📂gamma_s
┃ ┃ ┣ 📜2021GO-01830.gamma
┃ ┃ ┗ 📜2021GO-01830.psl
┃ ┣ 📂hyper_virulence
┃ ┃ ┣ 📜2021GO-01830.gamma
┃ ┃ ┗ 📜2021GO-01830.psl
┃ ┣ 📂kraken2_asmbld
┃ ┃ ┣ 📜2021GO-01830.classified.fastq.gz
┃ ┃ ┣ 📜2021GO-01830.kraken2.classifiedreads.txt
┃ ┃ ┣ 📜2021GO-01830.kraken2.report.txt
┃ ┃ ┗ 📜2021GO-01830.unclassified.fastq.gz
┃ ┣ 📂kraken2_trimd
┃ ┃ ┣ 📜2021GO-01830.classified_1.fastq.gz
┃ ┃ ┣ 📜2021GO-01830.classified_2.fastq.gz
┃ ┃ ┣ 📜2021GO-01830.kraken2.classifiedreads.txt
┃ ┃ ┣ 📜2021GO-01830.kraken2.report.txt
┃ ┃ ┣ 📜2021GO-01830.unclassified_1.fastq.gz
┃ ┃ ┗ 📜2021GO-01830.unclassified_2.fastq.gz
┃ ┣ 📂mlst
┃ ┃ ┗ 📜2021GO-01830.tsv
┃ ┣ 📂quast
┃ ┃ ┗ 📜report.tsv
┃ ┣ 📂removedAdapters
┃ ┃ ┣ 📜2021GO-01830.bbduk.log
┃ ┃ ┣ 📜2021GO-01830_1.fastq.gz
┃ ┃ ┗ 📜2021GO-01830_2.fastq.gz
┃ ┗ 📂srst2
┃ ┃ ┣ 📜1085__blaIMP__blaIMP-27_NG_049191.1__03859__beta-lactam__NCBI.2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.pileup
┃ ┃ ┣ 📜124__sat2_gen__sat2_gen_NG_051936.1__05541__streptothricin__NCBI.2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.pileup
┃ ┃ ┣ 📜2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.pileup
┃ ┃ ┣ 📜2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.sorted.bam
┃ ┃ ┣ 📜2021GO-01830__fullgenes__ResGANNCBI_20210507_srst2__results.txt
┃ ┃ ┣ 📜2021GO-01830__genes__ResGANNCBI_20210507_srst2__results.txt
┃ ┃ ┣ 📜238__tet(59)__tet(59)_NG_056044.1__01798__tetracycline__NCBI.2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.pileup
┃ ┃ ┣ 📜486__aadA1__aadA1_NG_047327.1__03489__aminoglycoside__NCBI.2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.pileup
┃ ┃ ┣ 📜967__aadA15__aadA15_NG_047338.1__04467__aminoglycoside__NCBI.2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.pileup
┃ ┃ ┗ 📜970__aadA11__aadA11_NG_051873.1__03942__aminoglycoside__NCBI.2021GO-01830__2021GO-01830.ResGANNCBI_20210507_srst2.pileup
┣ 📂multiqc
┃ ┣ 📂multiqc_data
┃ ┃ ┣ 📜mqc_fastqc_per_base_n_content_plot_1.txt
┃ ┃ ┣ 📜mqc_fastqc_per_base_sequence_quality_plot_1.txt
┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Counts.txt
┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Percentages.txt
┃ ┃ ┣ 📜mqc_fastqc_per_sequence_quality_scores_plot_1.txt
┃ ┃ ┣ 📜mqc_fastqc_sequence_counts_plot_1.txt
┃ ┃ ┣ 📜mqc_fastqc_sequence_duplication_levels_plot_1.txt
┃ ┃ ┣ 📜mqc_fastqc_sequence_length_distribution_plot_1.txt
┃ ┃ ┣ 📜multiqc.log
┃ ┃ ┣ 📜multiqc_data.json
┃ ┃ ┣ 📜multiqc_fastqc.txt
┃ ┃ ┣ 📜multiqc_general_stats.txt
┃ ┃ ┗ 📜multiqc_sources.txt
┃ ┣ 📂multiqc_plots
┃ ┃ ┣ 📂pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_base_n_content_plot_1.pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_base_sequence_quality_plot_1.pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Counts.pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Percentages.pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_quality_scores_plot_1.pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_counts_plot_1.pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_counts_plot_1_pc.pdf
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_duplication_levels_plot_1.pdf
┃ ┃ ┃ ┗ 📜mqc_fastqc_sequence_length_distribution_plot_1.pdf
┃ ┃ ┣ 📂png
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_base_n_content_plot_1.png
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_base_sequence_quality_plot_1.png
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Counts.png
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Percentages.png
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_quality_scores_plot_1.png
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_counts_plot_1.png
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_counts_plot_1_pc.png
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_duplication_levels_plot_1.png
┃ ┃ ┃ ┗ 📜mqc_fastqc_sequence_length_distribution_plot_1.png
┃ ┃ ┗ 📂svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_base_n_content_plot_1.svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_base_sequence_quality_plot_1.svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Counts.svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_gc_content_plot_Percentages.svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_per_sequence_quality_scores_plot_1.svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_counts_plot_1.svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_counts_plot_1_pc.svg
┃ ┃ ┃ ┣ 📜mqc_fastqc_sequence_duplication_levels_plot_1.svg
┃ ┃ ┃ ┗ 📜mqc_fastqc_sequence_length_distribution_plot_1.svg
┃ ┗ 📜multiqc_report.html
┗ 📂pipeline_info
┃ ┣ 📜execution_report_2022-05-31_13-00-00.html
┃ ┣ 📜execution_timeline_2022-05-31_13-00-00.html
┃ ┣ 📜execution_trace_2022-05-31_13-00-00.txt
┃ ┣ 📜pipeline_dag_2022-05-31_13-00-00.svg
┃ ┣ 📜samplesheet.valid.csv
┃ ┗ 📜software_versions.yml

This is the case for running one sample.

Running on a HPC

To run Q-H on an HPC and submit jobs to a cluster you will need to make config file for your executor. We provide a template in the conf folder to edit. Then run the program by running:

nextflow run CDCgov/phoenix -profile singularity,custom_HPC --input samplesheet.csv