pyani-plus
Development repo for pyani-plus (the next iteration of pyani)
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 6 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Keywords
Repository
Development repo for pyani-plus (the next iteration of pyani)
Basic Info
- Host: GitHub
- Owner: pyani-plus
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://pyani-plus.github.io/pyani-plus-docs/
- Size: 12.8 MB
Statistics
- Stars: 15
- Watchers: 3
- Forks: 2
- Open Issues: 30
- Releases: 5
Topics
Metadata Files
README.md
pyANI-plus
pyani-plus is an application and Python module for whole-genome classification of microbes using Average Nucleotide Identity and similar methods. It is a reimplemented version of pyani with support for additional schedulers and methods.
Citing pyANI-plus
A complete guide to citing pyani is included in the file CITATIONS. Please cite the following manuscript in your work, if you have found pyani useful:
Pritchard et al. (2016) "Genomics and taxonomy in diagnostics for food security: soft-rotting enterobacterial plant pathogens" Anal. Methods 8, 12-24 DOI: 10.1039/C5AY02550H
Documentation
See pyANI-plus documentation including Walkthrough: A First Analysis.
Installation
See our full installation instructions for more details. In brief, if you are using conda we recommend
pyani-plus from the BioConda channel,
which will include all the dependencies. Otherwise, we recommend installing pyani-plus
from the Python Package Index (PyPI),
and install the non-python tools as needed.
If you would like to use the in-progress development version, please follow the usual installation procedure for GitHub repositories, e.g.
- Clone the repository:
git clone git@github.com:pyani-plus/pyani-plus.git - Change directory to the repository:
cd pyani-plus - Create a new conda environment called
pyani-plus_py312using the commandmake setup_conda_env(there is a correspondingremove_conda_envtarget) - Activate the conda environment with the command
conda activate pyani-plus_py312 - Install using one of the following methods:
-
pip, e.g.:pip install -U -e . -
Make, e.g.:make install_macosormake install_linux
-
Contributing
Please see the CONTRIBUTING.md file for more information,
including installing additional development-only dependencies like pytest and ruff.
Licensing
Unless otherwise indicated, the material in this project is made available under the MIT License, and copyright The University of Strathclyde 2024 to present. See the LICENSE file.
Contact: leighton.pritchard@strath.ac.uk
Address: Dr Leighton Pritchard, Strathclyde Institute of Pharmacy and Biomedical Sciences 161 Cathedral Street Glasgow G4 0RE, Scotland, UK
Owner
- Name: pyani-plus
- Login: pyani-plus
- Kind: organization
- Repositories: 1
- Profile: https://github.com/pyani-plus
Citation (CITATIONS)
# CITATIONS
Please cite the following manuscript in your work, if you have found pyani-plus (or the older pyani) useful:
Pritchard et al. (2016) "Genomics and taxonomy in diagnostics for food security: soft-rotting enterobacterial plant pathogens" Anal. Methods, 2016,8, 12-24
DOI: 10.1039/C5AY02550H
@Article{C5AY02550H,
author ="Pritchard, Leighton and Glover, Rachel H. and Humphris, Sonia and Elphinstone, John G. and Toth, Ian K.",
title ="Genomics and taxonomy in diagnostics for food security: soft-rotting enterobacterial plant pathogens",
journal ="Anal. Methods",
year ="2016",
volume ="8",
issue ="1",
pages ="12-24",
publisher ="The Royal Society of Chemistry",
doi ="10.1039/C5AY02550H",
url ="http://dx.doi.org/10.1039/C5AY02550H",
abstract ="Soft rot Enterobacteriaceae (SRE) are bacterial plant pathogens that cause blackleg{,} wilt and soft rot diseases on a broad range of important crop and ornamental plants worldwide. These organisms (spanning the genera Erwinia{,} Pectobacterium{,} Dickeya{,} and Pantoea) cause significant economic and yield losses in the field{,} and in storage. They are transmissible through surface water{,} by trade and other movement of plant material and soil{,} and in some cases are subject to international legislative and quarantine restrictions. Effective detection and diagnosis in support of food security legislation and epidemiology is dependent on the ability to classify pathogenic isolates precisely. Diagnostics and classification are made more difficult by the influence of horizontal gene transfer on phenotype{,} and historically complex and sometimes inaccurate nomenclatural and taxonomic assignments that persist in strain collections and online sequence databases. Here{,} we briefly discuss the relationship between taxonomy{,} genotype and phenotype in the SRE{,} and their implications for diagnostic testing and legislation. We present novel whole-genome classifications of the SRE{,} illustrating inconsistencies between the established taxonomies and evidence from completely sequenced isolates. We conclude with a perspective on the future impact of widespread whole-genome sequencing and classification methods on detection and identification of bacterial plant pathogens in support of legislative and policy efforts in food security."}
When citing pyani-plus (or the older pyani) in your text, please quote the precise release version if you are using a specific release, or the specific commit hash (if you are using the 'bleeding-edge' development version), e.g.
"...using pyani-plus (v1.0.0)..."
or
"...using pyani-plus (commit e401925)..."
This will enable precise reproduction of this part of your work by others.
Each release will have a unique DOI for Zenodo which can also be cited, see https://doi.org/10.5281/zenodo.15005805 for this.
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 52
- Total pull requests: 98
- Average time to close issues: 23 days
- Average time to close pull requests: 5 days
- Total issue authors: 7
- Total pull request authors: 4
- Average comments per issue: 1.52
- Average comments per pull request: 2.78
- Merged pull requests: 73
- Bot issues: 0
- Bot pull requests: 27
Past Year
- Issues: 51
- Pull requests: 98
- Average time to close issues: 16 days
- Average time to close pull requests: 5 days
- Issue authors: 7
- Pull request authors: 4
- Average comments per issue: 1.45
- Average comments per pull request: 2.78
- Merged pull requests: 73
- Bot issues: 0
- Bot pull requests: 27
Top Authors
Issue Authors
- peterjc (43)
- widdowquinn (42)
- kiepczi (12)
- d-courtine (1)
- Aveglia (1)
- LanSabb (1)
- sarah872 (1)
- pre-commit-ci[bot] (1)
Pull Request Authors
- peterjc (155)
- pre-commit-ci[bot] (41)
- kiepczi (31)
- widdowquinn (18)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- coverage * development
- pre-commit * development
- pytest * development
- pytest-cov * development
- ruff * development
- types-tqdm * development
- mummer =3.23
- mummer =3.23=h6de7cb9_11
- actions/checkout v4 composite
- actions/upload-artifact v4 composite
- codacy/codacy-coverage-reporter-action v1.3.0 composite
- codecov/codecov-action v4.0.1 composite
- conda-incubator/setup-miniconda v3 composite
- actions/checkout v4 composite
- actions/upload-artifact v4 composite
- codacy/codacy-coverage-reporter-action v1.3.0 composite
- codecov/codecov-action v4.0.1 composite
- conda-incubator/setup-miniconda v3 composite