Skip to main content

Natural Products Linker

Project description

Badges

fair-software.eu recommendations
(1/5) code repository github repo badge
(2/5) license github license badge
(3/5) community registry pypi badge Docker Image Version (latest by date)
(4/5) citation Zenodo
(5/5) checklist Coming soon
how FAIR is fair-software badge
Other best practices
Documentation Documentation Status
Build & Test build
Static analysis workflow scq badge
Coverage workflow scc badge
Citation data consistency cffconvert
Downloads Docker Pulls

Natural Products Linker (NPLinker)

NPLinker aims to address the significant bottleneck that exists in the realization of the potential of genome-led metabolite discovery, namely the slow manual matching of predicted biosynthetic gene clusters (BGCs) with metabolites produced during bacterial culture; linking phenotype to genotype.

NPLinker implements a new data-centric approach to alleviate this linking problem by searching for patterns of strain presence and absence between groups of similar spectra (molecular families; MF) and groups of similar BGCs (gene cluster families; GCF). Searches can be performed using a number of available analysis methods employed in isolation or together.

Currently available analysis methods (scoring methods):

Setup and usage

NPLinker is a Python package, you can install it as following:

# create a new virtual environment
python -m venv env
source env/bin/activate

# install nplinker package
pip install nplinker

# install nplinker non-pypi dependencies and databases
install-nplinker-deps

Due to hardware requirements of some non-pypi dependecies:

  • NPLinker can only be installed on Linux and MacOS (Intel chip)
  • MacOS(Apple Silicon, M1/M2 chip) user should execute the install commands in a Rosseta-enabled terminal.
  • For Windows users, please use our docker image.

See the example in Jupyter notebook for a guided introduction to the NPLinker API which shows how to load and examine a dataset. Other notebooks are present showcasing other scoring methods, like for NPClassScore.

If you want to visualize and manipulate NPLinker predictions, check NPLinker Webapp for more info.

Contributing

If you want to contribute to the development of nplinker, have a look at the contribution guidelines and README for developers.

Project details


Download files

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

Source Distribution

nplinker-1.3.2.tar.gz (6.0 MB view details)

Uploaded Source

Built Distribution

nplinker-1.3.2-py3-none-any.whl (6.1 MB view details)

Uploaded Python 3

File details

Details for the file nplinker-1.3.2.tar.gz.

File metadata

  • Download URL: nplinker-1.3.2.tar.gz
  • Upload date:
  • Size: 6.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for nplinker-1.3.2.tar.gz
Algorithm Hash digest
SHA256 7b55b015aa2a078e051e54c6a9aa34e74981c46bf47e0b990c8a5f3143de8f04
MD5 31b017332bcb904f4dea717fbb0caa9f
BLAKE2b-256 2b665450aa5032557a8b814a4685a48b7fb6cc98a5fa7da1eb05f614a5ef1cc4

See more details on using hashes here.

Provenance

File details

Details for the file nplinker-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: nplinker-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 6.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for nplinker-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0abfa35cda46e813d71736a5c6a9a139dcedcfea1e93bc88312fb6828023dc57
MD5 29f25e584647a0b227fa0f3d5d6cb436
BLAKE2b-256 1b45b70266aab4e62adb71dc82c55246027829233be93923e68fb9ac1a3f6c9f

See more details on using hashes here.

Provenance

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