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

Sadly the command line dependencies likely rule out using Windows directly.

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.

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

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.2.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

thapbi_pict-0.9.2-py3-none-any.whl (554.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thapbi_pict-0.9.2.tar.gz
  • Upload date:
  • Size: 2.6 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.2.tar.gz
Algorithm Hash digest
SHA256 020d343fd19fe9c5bf760a0ed64c2d747fa9d5dafa8a6d977e2783089ea3ed4b
MD5 49c8b92323a084b78a1bd2d09becf9fa
BLAKE2b-256 449343c03a6d9eb4de025ceb69ad99cf0b1b764e48ba51b71924e9fe07ae45e0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: thapbi_pict-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 554.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e0f6c52042bf3dcb11e9a48ab8224f2ac79d0c85a8afec3d790bb4c6737c8622
MD5 980d2a6a645afddd2fabeeff32bb7363
BLAKE2b-256 777dd3d55c4d5c5485225287cd00fab8f1d33c53a2ef6fcc1364deaab3c389dc

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