thapbi-pict 0.4.0

THAPBI Phytophthora ITS1 Classifier Tool (PICT).

THAPBI Phytophthora ITS1 Classifier Tool (PICT)

About

THAPBI PICT is an ITS1-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.

Installation

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

$ conda install thapbi_pict

The same should work on macOS, but 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.

Funding

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

Background

This continues earlier work including:

• https://github.com/widdowquinn/THAPBI

• https://github.com/widdowquinn/THAPBI-pycits

• https://github.com/peterthorpe5/THAPBI-pycits

• https://github.com/peterthorpe5/public_scripts/tree/master/metapy

• https://github.com/peterthorpe5/public_scripts/tree/master/metapy_tools

Release History

See the CHANGELOG.rst file (it was getting too long to include here).

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.