Skip to main content

THAPBI Phytophthora ITS1 Classifier Tool (PICT).

Project description

THAPBI PICT on the Python Package Index (PyPI) THAPBI PICT on BioConda THAPBI PICT CircleCI build status Documentation Status Code style: black Zenodo DOI

THAPBI Phytophthora ITS1 Classifier Tool (PICT)

About

THAPBI PICT is a sequence based diagnostic/profiling tool from the UK funded Tree Health and Plant Biosecurity Initiative (THAPBI) Phyto-Threats project, focused on identifying Phytophthora species present in Illumina sequenced environmental samples.

Phytophthora (from Greek meaning plant-destroyer) species are economically important plant pathogens, important in both agriculture and forestry. ITS1 is short for Internal Transcribed Spacer one, which is a region of eukaryotes genomes between the 18S and 5.8S rRNA genes. This is commonly used for molecular barcoding, where sequencing this short region can identify species.

With appropriate primer settings and a custom database of full length markers, THAPBI PICT can be applied to other organisms and/or barcode marker sequences - not just Phytophthora ITS1. It requires overlapping paired-end Illumina reads which can be merged to cover the full amplicon marker. Longer markers or fragmented amplicons are not supported. Internally it works by tracking amplicon sequence variants (ASVs), using MD5 checksums as identifiers.

The worked examples include oomycetes, fungi, microalgae, and bats, and cover markers in ITS1, ITS2, 18S rRNA and COI and more. The main criteria has been mock communities with known species composition.

Installation

We recommend installing this tool on Linux or macOS using the Conda packaging system, via the BioConda channel, which will handle all the dependencies:

$ conda install thapbi_pict

Alternatively, since the software is on the Python Package Index (PyPI), the following command will install it along with its Python dependencies:

$ pip install thapbi_pict

However, in this case you will still need to install various external command line tools. See INSTALL.rst for more details, and if you want to modify the software read CONTRIBUTING.rst as well.

If you are on Windows, and do not wish or cannot use the Windows Subsystem for Linux (WSL), using the tool should still be possible although not all the command line dependencies are available on Conda. You can install BLAST (if required) by hand from the NCBI, and there are alternatives to unzip and md5sum for following the worked examples.

Quick Start

Once installed, you should be able to run the tool at the command line using:

$ thapbi_pict

This should automatically find the installed copy of the Python code. Use thapbi_pict -v to report the version, or thapbi_pict -h for help.

Documentation

The tool documentation is hosted by Read The Docs, generated automatically from the docs/ folder.

The documentation includes more detailed discussion of the sample datasets in the examples/ folder (which are based on published datasets).

Funding

The Phyto-Threats project was supported from 2016 to 2019 under the Tree Health and Plant Biosecurity Initiative (THAPBI), jointly funded by the Biotechnology and Biological Sciences Research Council (BBSRC), Department for Environment, Food and Rural affairs (DEFRA), Economic and Social Research Council (ESRC), Forestry Commission, Natural Environment Research Council (NERC) and Scottish Government.

Background

THAPBI PICT continues earlier work including:

Release History

See the CHANGELOG.rst file.

Development Notes

Please see the CONTRIBUTING.rst file for details of the development setup including Python style conventions, git pre-commit hook, continuous integration and test coverage, and release process.

Project details


Release history Release notifications | RSS feed

This version

0.9.4

Download files

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

Source Distribution

thapbi_pict-0.9.4.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

thapbi_pict-0.9.4-py3-none-any.whl (515.9 kB view details)

Uploaded Python 3

File details

Details for the file thapbi_pict-0.9.4.tar.gz.

File metadata

  • Download URL: thapbi_pict-0.9.4.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for thapbi_pict-0.9.4.tar.gz
Algorithm Hash digest
SHA256 d29b6fb9bd051f31c25eae0c1832371c4d18521879acb9aab5309cbfcbd6ae0c
MD5 d69f35ec83a2140ff1dc2b66cf814b5f
BLAKE2b-256 416a08eef5972e35b17319a9f3f60df4e4ad6873b1ac9ac5b15848aafbf1ddc4

See more details on using hashes here.

File details

Details for the file thapbi_pict-0.9.4-py3-none-any.whl.

File metadata

  • Download URL: thapbi_pict-0.9.4-py3-none-any.whl
  • Upload date:
  • Size: 515.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for thapbi_pict-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2d51bf29a5fce2963d7e558f3ba54c9a0a0774ed15808c6302827a09cde77ddf
MD5 be8e4cae9a138ffbb6e3a0bedeed055c
BLAKE2b-256 e87c4acb6068f3b230b2631392a3f9a0390987c4f59c31eae77934ffb694b19e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page