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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

thapbi_pict-0.8.3-py3-none-any.whl (581.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thapbi_pict-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 581.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.8

File hashes

Hashes for thapbi_pict-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ac1812546cb8fbf9052dee3fe218dfbb7406a2f42c8932c7390683e51b7faaff
MD5 69c578e6948086148634555138d71b16
BLAKE2b-256 30826d8d07fbfe6c44f5ce3272d3599f75700f62ec7d6c0f190decb2c760113e

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