Skip to main content

MIGHT: MRSN Integrated Genome Handling Tool for bacterial clinical isolates

Project description

MIGHT

MIGHT: MRSN Integrated Genome Handling Tool for bacterial clinical isolates

Contents

Introduction

MIGHT was developed as a way to automate many of the standard bioinformatics tasks that the MRSN performs as part of its surveillance mission.

Brief summary of the workflow:

  1. Run bcl2fastq to demultiplex Illumina paired-end read data from MiSeq/Nextseq data
  2. Run Kraken2 to get species ID and identify possible sample contamination
  3. Preprocess short reads using bbduk for short read data and/or filtlong for long read data
  4. Run the Unicycler assembler (with or without long read data)
  5. Run QUAST to gather assembly statistics
  6. Run Andale, a hybrid read/assembly AMR gene identification tool

Installation

This script is designed to be installed and run using conda

Conda Installation

Usage

MIGHT can be run either on a single isolate using Might.py or on all of the samples of an Illumina run using AllMight.py. The primary difference from an input perspective is that Might.py assumes that you are processing a single sample for which you will provide 1) the sample name and 2) the location(s) or the relevant input files. Conversely, AllMight.py will takes a user provided SampleSheet.csv to determine what samples should be included in the run. It will ultimately run the specified analyses on each sample as parallel implementations of the analysis methods found in Might.py.

For a single isolate:




          .___  ___.  __    _______  __    __  .__________.
          |   \/   | |  |  /  _____||  |  |  | |          |
          |  \  /  | |  | |  |  __  |  |__|  | `---|  |---`
          |  |\/|  | |  | |  | |_ | |   __   |     |  |     
          |  |  |  | |  | |  |__| | |  |  |  |     |  |     
          |__|  |__| |__|  \______| |__|  |__|     |__|     



usage: Might.py --output OUTPUT [--sample-name SAMPLE_NAME] [--fastq FASTQ]
              [--fasta FASTA] [--all] [--kraken2] [--assembly]
              [--amr {combination,reads,contigs,summary}] [--mlst]
              [--plasmidfinder] [--kraken2-database KRAKEN2_DATABASE]
              [--adapter-file ADAPTER_FILE] [--ramdisk RAMDISK] [--update]
              [--force] [--cores CORES] [--verbosity VERBOSITY] [-h]

MIGHT! MRSN Integrated Genome Handling Tool

Required arguments:
--output OUTPUT       path to the directory where output is/will be stored

Input arguments:
--sample-name SAMPLE_NAME
                      Name of the sample to be analyzed.
--fastq FASTQ         path to the directory containing the read files for
                      this sample [output/reads/raw_reads]
--fasta FASTA         path to the directory containing the assembly file for
                      this sample [output/assembly]

Analysis arguments:
--all                 run all analysis options
--kraken2             run Kraken2 on read files to determine species ID and
                      potentially detect contamination
--assembly            trim and filter reads using bbduk, then perform
                      assembly using Unicycler
--amr {combination,reads,contigs,summary}
                      run Andale using one of the four setting choices
--mlst                perform MLST assignments for samples using MLST
--plasmidfinder       run Plasmidfinder on contig files to identify rep gene
                      content

Resource arguments:
--kraken2-database KRAKEN2_DATABASE
                      Path to the kraken2 database. Required for kraken2
                      analysis
--adapter-file ADAPTER_FILE
                      Path to the adapter.fa file required for adapter
                      trimming of Illumina reads
--ramdisk RAMDISK     Path to the ramdisk for speeding up kraken2

Optional arguments:
--update              update AMRFinderPlus and MLST databases
--force               force overwrite of existing data/output related to
                      this sample
--cores CORES         the MAXIMUM number of CPUs to use in the analysis [1]
--verbosity VERBOSITY
                      the level of reporting done to the terminal window [1]

Help:
-h, --help            show this help message and exit

For an Illumina run



            .___  ___.  __    _______  __    __  .__________.
            |   \/   | |  |  /  _____||  |  |  | |          |
            |  \  /  | |  | |  |  __  |  |__|  | `---|  |---`
            |  |\/|  | |  | |  | |_ | |   __   |     |  |     
            |  |  |  | |  | |  |__| | |  |  |  |     |  |     
            |__|  |__| |__|  \______| |__|  |__|     |__|     



usage: AllMight.py --output OUTPUT [--bcl2fastq]
                   [--run-directory RUN_DIRECTORY]
                   [--sample-sheet SAMPLE_SHEET] [--all] [--kraken2]
                   [--assembly] [--amr {combination,reads,contigs,summary}]
                   [--mlst] [--plasmidfinder]
                   [--kraken2-database KRAKEN2_DATABASE]
                   [--adapter-file ADAPTER_FILE] [--ramdisk RAMDISK]
                   [--update] [--force] [--cores CORES]
                   [--verbosity VERBOSITY] [-h]

MIGHT! MRSN Integrated Genome Handling Tool

Required arguments:
  --output OUTPUT       path to the directory where output is/will be stored

bcl2fastq2 arguments:
  --bcl2fastq           Run bcl2fastq2 to generate demultiplexed fastq files
                        from the bcl files
  --run-directory RUN_DIRECTORY
                        Path to the run directory to be analyzed
  --sample-sheet SAMPLE_SHEET
                        Path to the Illumina sample sheet file for the run
                        being analyzed

Analysis arguments:
  --all                 run all analysis options
  --kraken2             run Kraken2 on read files to determine species ID and
                        potentially detect contamination
  --assembly            trim and filter reads using bbduk, then perform
                        assembly using Unicycler
  --amr {combination,reads,contigs,summary}
                        run Andale using one of the four setting choices
  --mlst                perform MLST assignments for samples using MLST
  --plasmidfinder       run Plasmidfinder on contig files to identify rep gene
                        content

Resource arguments:
  --kraken2-database KRAKEN2_DATABASE
                        Path to the kraken2 database. Required for kraken2
                        analysis
  --adapter-file ADAPTER_FILE
                        Path to the adapter.fa file required for adapter
                        trimming of Illumina reads
  --ramdisk RAMDISK     Path to the ramdisk for speeding up kraken2

Optional arguments:
  --update              update AMRFinderPlus and MLST databases
  --force               force overwrite of existing data/output related to
                        this sample
  --cores CORES         the MAXIMUM number of CPUs to use in the analysis [1]
  --verbosity VERBOSITY
                        the level of reporting done to the terminal window [1]

Help:
  -h, --help            show this help message and exit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mrsn-might, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size mrsn_might-1.0.5-py3-none-any.whl (47.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mrsn-might-1.0.5.tar.gz (32.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page