Skip to main content

Find Lysine Acylation & other Modification Sites

Project description

FLAMS: Find Lysine Acylations & other Modification Sites

A command-line tool to analyze the conservation of lysine modifications, by means of a position-based search against the CPLM database v.4.

Table of contents

  1. Introduction
  2. System requirements
    1. General dependencies
    2. Third-party tools
  3. Installation
  4. Usage
  5. Output
  6. Contact
  7. References

Introduction

FLAMS is a tool that looks for conservation of modifications on lysine residues by first looking for similar proteins in the Compendium of Protein Lysine Modification Sites (CPLM v.4, Zhang, W. et al. Nucleic Acids Research. 2021, 44 (5): 243–250.), and then extracting those proteins that contain a modified lysine at the queried position. The aim of this analysis is to easily identify conserved lysine modifications, to aid in identifying functional lysine modification sites and the comparison of the results of PTM identification studies across species.

The tool takes as input a protein sequence and the position of a lysine. This repository contains a command-line tool FLAMS to obtain an overview of the conserved lysine modifications matching your query, by using the following scripts:

  • input.py: processing the user-provided input
  • cplm4.py and setup.py: downloading and preparing the modification-specific databases
  • run_blast.py: searching your query against the databases of proteins with lysine modifications
  • display.py: formatting the list of conserved lysine modifications to a tab delimited output file

System requirements

Linux 64-bit and Mac OS supported. Windows users are advised to run the tool through Anaconda.

General dependencies

  • Python3 (>=3.10)

Third-party dependencies

Installation

The recommended installation is through pip:

pip install flams

Please make sure that BLAST is installed locally, and available in the PATH.

Usage

Run the tool:

FLAMS [-h] (--in inputFilePath | --id UniProtID) -p position [--range errorRange] [-t threadsBLAST] [-o outputFilePath] [-d dataDir] [-m modification [modification ...]]

Required arguments:

  • one of:
    • inputFilePath is the path to a .fasta file with the protein you wish to query against (has to contain only 1 protein)
    • UniProtID is the UniProt ID of the protein you wish to query against
  • position is the position of a lysine in the protein, which you want to query against

Optional arguments:

  • errorRange is an number of positions before and after pos to also search for modifications. [default: 0]
  • threadsBLAST is a BLAST parameter, allows you to speed up the search by multithreading. [default: 1]
  • outputFilePath is the path to where the result will be saved (in a .tsv file format). [default: out.tsv]
  • dataDir is the path to directory where intermediate files (the UniProt sequence files) are stored. [default: $PWD/data]"
  • modification is one or a combination (seperated by spaces) of: ubiquitination, sumoylation, pupylation, neddylation, acetylation, succinylation, crotonylation, malonylation, 2-hydroxyisobutyrylation, beta-hydroxybutyrylation, butyrylation, propionylation, glutarylation, lactylation, formylation, benzoylation, hmgylation, mgcylation, mgylation, methylation, glycation, hydroxylation, phosphoglycerylation, carboxymethylation, lipoylation, carboxylation, dietylphosphorylation, biotinylation, carboxyethylation. We also provide aggregated combinations: 'All','Ubs','Acylations' and'Others', in analogy to the CPLM database. [default: Acylations]"

Example:

FLAMS --in P57703.fa -p 306 --range 5 -o results.tsv -m acetylation succinylation

FLAMS --id P57703 -p 738

For more example use cases, see the Supplementary information of the paper.

Output

The output file is a .tsv containing one row per modification that matched the query, i.e., aligning (within the user-specified range) to the query lysine, in a protein similar to the query protein. The output file contains five columns:

  • UniProt ID: UniProt identifier of matched protein
  • Modification: the type of modification found in the matched protein
  • Lysine location: the location of this matched modification in the matched protein
  • Lysine window: the local sequence containing the conserved lysine modification (window of five amino acids before and after°)
  • Species: the textual description of the species of the matched protein

°: window can be smaller than the [-5;+5] window if the sequence alignment ends sooner, which can happen for modified lysines near the start/end of the protein

Contact

Laboratory of Computational Systems Biology, KU Leuven.

References

Zhang, W., Tan, X., Lin, S., Gou, Y., Han, C., Zhang, C., Ning, W., Wang, C. & Xue, Y. (2021) "CPLM 4.0: an updated database with rich annotations for protein lysine modifications." Nucleic Acids Research. 44(5):243–250.

Altschul, S.F., Gish, W., Miller, W., Myers, E.W. & Lipman, D.J. (1990) "Basic local alignment search tool." J. Mol. Biol. 215:403-410.

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

flams-0.0.6.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

flams-0.0.6-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file flams-0.0.6.tar.gz.

File metadata

  • Download URL: flams-0.0.6.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/6.0.0 pkginfo/1.9.6 requests/2.29.0 requests-toolbelt/0.9.1 tqdm/4.65.0 CPython/3.11.3

File hashes

Hashes for flams-0.0.6.tar.gz
Algorithm Hash digest
SHA256 1967a3efbe2c62b3a0bd1446c9e094c3645b3f941a13da0f00c58dc39a5d6c0d
MD5 a900d8cf677445534e6bf5a4ceda4c5f
BLAKE2b-256 62bfac35c88c812083da560689c7712c27c23aaa7d83af6230b68289f469c4a7

See more details on using hashes here.

File details

Details for the file flams-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: flams-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/6.0.0 pkginfo/1.9.6 requests/2.29.0 requests-toolbelt/0.9.1 tqdm/4.65.0 CPython/3.11.3

File hashes

Hashes for flams-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 db410841e43d98e8ccfb798830ce863afadb081759e5180584ed9f8e67602ccc
MD5 7882de846ed55ee5e04adb93d6079807
BLAKE2b-256 7c840cc5136e59d4e96d8d9e0bc013958dc41ab5389bbdacf7c561e4748d1d30

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