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 RSD workflow pypi badge
(4/5) citation DOI
(5/5) checklist workflow cii badge
howfairis fair-software badge
Other best practices  
Static analysis workflow scq badge
Coverage workflow scc badge
Documentation Documentation Status
GitHub Actions  
Build build
Citation data consistency cffconvert
SonarCloud sonarcloud
MarkDown link checker markdown-link-check

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nplinker-1.3.1.tar.gz
Algorithm Hash digest
SHA256 866b3e0c6e22ca29b61b44d618b6d09d024d389d6fb3fef926742dbc880aa645
MD5 781923ecc06274a1b60dc81ab5141d79
BLAKE2b-256 7f5e7ca56c9f3881f502521256a90520516e1e651ccf069779225cf0cfb741a5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nplinker-1.3.1-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.7.13

File hashes

Hashes for nplinker-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a8ff39073a0f50280eadfb456f3b457b2e4dafd56bfa38bbd2c670da15d5a01
MD5 5d327a9d4de29d52c5cfe30490374dcc
BLAKE2b-256 6b1fd027ecb88d05f4bd164232541ea13598ff2b6c07aee674dcea2ca3494a2a

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