ITSxpress: Software to rapidly trim the Internally transcribed spacer (ITS) region of FASTQ files

Documentation Status Build Status Anaconda-Server Badge GitHub release (latest by date) https://zenodo.org/badge/DOI/10.5281/zenodo.1304349.svg

Author

  • Adam R. Rivers, US Department of Agriculture, Agricultural Research Service

  • Sveinn V. Einarsson, US Department of Agriculture, Agricultural Research Service

Citation

Rivers AR, Weber KC, Gardner TG et al. ITSxpress: Software to rapidly trim internally transcribed spacer sequences with quality scores for marker gene analysis [version 1; referees: awaiting peer review]. F1000Research 2018, 7:1418 (doi: 10.12688/f1000research.15704.1)

Introduction

The internally transcribed spacer region is a region between highly conserved the small subunit (SSU) of rRNA and the large subunit (LSU) of the rRNA. In Eukaryotes it contains the 5.8s genes and two variable length spacer regions. In amplicon sequencing studies it is common practice to trim off the conserved (SSU, 5,8S or LSU) regions. Bengtsson-Palme et al. (2013) published software the software package ITSx to do this.

ITSxpress is designed to support the calling of exact sequence variants rather than OTUs. This newer method of sequence error-correction requires quality score data from each sequence, so each input sequence must be trimmed. ITSXpress makes this possible by taking FASTQ data, de-replicating the sequences then identifying the start and stop sites using HMMSearch. Results are parsed and the trimmed files are returned. The ITS 1, ITS2 or the entire ITS region including the 5.8s rRNA gene can be selected. ITSxpress uses the hmm model from ITSx so results are comparable.

ITSxpress is also a QIIME2 plugin. Starting from version 2.0.0 of ITSxpress, the QIIME2 plugin is included with the command line version of ITSxpress. The installation method will be slightly different depending on whether QIIME2 is being used.

Environment with or without QIIME2

Create a new conda environment before installing ITSxpress.

If using QIIME2, follow the installation instructions on their wiki: https://docs.qiime2.org/2022.11/install/native/

As of now ITSxpress is compatible with version 2022.8 and 2022.11 of QIIME2

Example:

wget https://data.qiime2.org/distro/core/qiime2-2022.11-py38-osx-conda.yml
mamba env create -n qiime2-2022.11 --file qiime2-2022.11-py38-osx-conda.yml
mamba activate qiime2-2022.11

If you are only installing the command line version of ITSxpress and not QIIME2:

mamba env create -n ITSxpress
mamba activate ITSxpress

Installation

Within either conda environment, described above, ITSxpress can be installed from:

  1. Bioconda: (preferred method because it handles dependencies, Pip is no longer maintained for ITSxpress>=2.0.0):

mamba install -c bioconda itsxpress
  1. The Github repository: https://github.com/USDA-ARS-GBRU/itsxpress

git clone https://github.com/USDA-ARS-GBRU/itsxpress.git

Dependencies

The software requires Vsearch, Hmmer and Biopython. Bioconda takes care of this for you so it is the preferred installation method.

Usage

Option

Description

-h, –help

Show this help message and exit.

–fastq

A .fastq, .fq, .fastq.gz or .fq.gz file.

Required.

–single_end

A flag to specify that the fastq file is single-ended (not paired). Default is false.

–fastq2

A .fastq, .fq, .fastq.gz or .fq.gz file representing read 2 if present, optional.

–outfile

The trimmed FASTQ file, if it ends in gz it will be gzipped.

–outfile2

The trimmed FASTQ read 2 file, if it ends in gz it will be gzipped. If used, reads will be retuned as unmerged pairs rather than than merged.

–tempdir

Specify the temp file directory. Default is None.

–keeptemp

Should intermediate files be kept? Default is false.

–region

Options : {ITS2, ITS1, ALL}

–taxa

Select the taxonomic group sequenced: {Alveolata, Bryophyta, Bacillariophyta, Amoebozoa, Euglenozoa, Fungi, Chlorophyta, Rhodophyta, Phaeophyceae, Marchantiophyta, Metazoa, Oomycota, Haptophyceae, Raphidophyceae, Rhizaria, Synurophyceae, Tracheophyta, Eustigmatophyceae, All}. Default Fungi.

–cluster_id

The percent identity for clustering reads range [0.99-1.0], set to 1 for exact de-replication. Default 1.0.

–log

Log file. Default is ITSxpress.log.

–threads

Number of processor threads to use. Default is 1.

–reversed_primers

Primers are in reverse orientation as in Taylor et al. 2016, DOI:10.1128/AEM.02576-16. If selected ITSxpress returns trimmed reads flipped to the forward orientation

–allow_staggered_reads

Allow merging staggered reads with –fastq_allowmergestagger for Vsearch –fastq_mergepairs. See Vsearch documentation. (Optional) Default is true.

Examples

Use case 1: Trimming the ITS2 region from a fungal amplicon sequencing dataset with forward and reverse gzipped FASTQ files using two cpu threads. Return a single merged file for use in Deblur.

itsxpress --fastq r1.fastq.gz --fastq2 r2.fastq.gz --region ITS2 \
--taxa Fungi --log logfile.txt --outfile trimmed_reads.fastq.gz --threads 2

ITSxpress can take uncompressed, gzipped or zstd compressed FASTQ files and it can write uncompressed, gzipped or zstd compressed FASTQ files. It expects FASTQ files to end in: .fq, .fastq, .fq.gz, fastq.gz, .fq.zst or fastq.zst.

Use case 2: Trimming the ITS2 region from a fungal amplicon sequencing dataset with forward and reverse gzipped FASTQ files using two cpu threads. Return a forward and reverse read files for use in Dada2.

itsxpress --fastq r1.fastq.gz --fastq2 r2.fastq.gz --region ITS2 \
--taxa Fungi --log logfile.txt --outfile trimmed_reads.fastq.gz --threads 2

ITSxpress can take uncompressed, gzipped or zstd compressed FASTQ files and it can write uncompressed, gzipped or zstd compressed FASTQ files. It expects FASTQ files to end in: .fq, .fastq, .fq.gz, fastq.gz, .fq.zst or fastq.zst.

Use case 3: Trimming the ITS2 region from a fungal amplicon sequencing dataset with an single-ended gzipped FASTQ files using two cpu threads.

itsxpress --fastq single-end.fastq.gz --single_end --region ITS2 --taxa Fungi \
--log logfile.txt --outfile trimmed_reads.fastq.gz --threads 2

Single ended data is less common and may come from a dataset where the reads have already been merged.

License information

This software is a work of the United States Department of Agriculture, Agricultural Research Service and is released under a Creative Commons CC0 public domain attribution. =======