Skip to main content

Find Lysine Acylation & other Modification Sites

Project description

FLAMS: Find Lysine Acylation & 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 delimeted 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)
  • shutil
  • BioPython

Third-party dependencies

Installation

The recommended installation takes place in a dedicated conda environment, which can be created as follows:

conda create -n flamsEnv

In this environment, the correct Python environment can be set up, and other dependencies can be installed through pip:

conda activate flamsEnv

conda install -c conda-forge python=3.10

pip install -r requirements.txt

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

Usage

Download the project:

git@github.com:hannelorelongin/flams-v1.git

cd flams

Run the tool:

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

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:

  • 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]"
  • 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]

Example:

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

python FLAMS --id P57703 738 -m acetylation propionylation

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. TSV output file contains five columns:

  • UniProt ID: UniProt identifier of matched protein
  • Species: the textual description of the species of the 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°)

°: 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.4.tar.gz (17.3 kB view details)

Uploaded Source

Built Distribution

flams-0.0.4-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flams-0.0.4.tar.gz
  • Upload date:
  • Size: 17.3 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.4.tar.gz
Algorithm Hash digest
SHA256 f5dfb55d599c3c47f06363c2b9f4537f1b9ce30edd059fa5be6922fbec9be6e7
MD5 5dd9e8e9561d1a206e73f1758c88aba0
BLAKE2b-256 71dd8ae96f9d454a68278060c248968f2bf6e208c886d502d10451b9434ff1ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flams-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 18.6 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1c6460da11b90342f57819ab8e464e8e99a1605c80f9c1df62a49b79522cdd2f
MD5 68482f7851c7aaa78dd505d4278dd457
BLAKE2b-256 3466e2e80267e4edf0cbe92cdb2d9d98f2f8aab51e830db6cb20e5358eaa3bcb

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