<i>In silico</i> mutagenesis of protein and RNA sequences using coevolution
Project description
About pycofitness
pycofitness is a Python implementation of in silico mutagenesis of a target protein or RNA sequence given in input the multiple sequence alignments (MSA) of its homologous sequences. It employs a pseudolikelihood maximization direct couplings analysis (DCA) algorithm to infer a coevolutionary energy and then use it to predict the impact of all single site mutations of the target protein.
The input file for pycofitness must be an MSA of sequences in fasta format, with the first sequence representing the sequence to mutate. The output consist of a txt file reporting the change of fitness for all single site variant of the protein.
More information about pycofitness can be found in the associated paper. If you use pycofitness please cite F.Pucci, M.Zerihun, M. Rooman, A. Schug, "pycofitness---Evaluating the fitness landscape of RNA and protein sequences", Bioinformatics, submitted (2023).
Prerequisites
pycofitness is implemented mainly in Python with the pseudolikelihood maximization parameter inference part implemented using C++ backend to enable parallelization. It requires:
- Python 3
- C++ compiler that supports C++11, e.g., the GNU compiler collection (GCC)
- Optionally, OpenMP for multithreading support
Installing
pycofitness can be installed from PyPI or from this repository. To install the current version of pycofitness from PyPI run
$ pip install pycofitness
The alternative way is to clone this repository and install pycofitness as
$ git clone https://github.com/KIT-MBS/pycofitness/
$ cd pycofitness
$ python setup.py install
Running pycofitness from the command line
When pycofitness is installed, it provides a command pycofitness that can be executed from the command line.
For example:
$ pycofitness <biomolecule> <msa_file> [--optional_arguments]
where <biomolecule> refers to values "protein" or "RNA" (case insensitive) and <msa_file> is the MSA file in the fasta format.
The optional arguments of pycofitness input are:
-h, --help: show these information about command line
--seqid SEQID: Cut-off value of sequences similarity above which sequences are lumped together in the calculation of frequencies.
--lambda_h LAMBDA_h: Value of penalizing constant for L2 regularization of fields in the pseudolikelyhood maximization DCA inference step (see here for more details).
--lambda_J LAMBDA_J: Value of penalizing constant for L2 regularization of couplings in the pseudolikelyhood maximization DCA inference step (see here for more details).
--max_iterations MAX_ITERATIONS: Maximum number of iterations for the gradient descent in the negative pseudolikelihood minimization step.
--num_threads NUM_THREADS: Number of threads used in the computation.
--output_dir OUTPUT_DIR: Directory path to which output results are written. If the directory is not existing, it will be created. If this path is not provided, an output directory is created using the base name of the MSA file, with "output_" prefix added to it.
--verbose: Show logging information on the terminal.
Using pycofitness as a Python library
After installation, pycofitness can be imported into other Python source codes and used. For example,
from pycofitness.mutation import PointMutation
point_mutation = PointMutation(msa_file, biomolecule)
deltas = point_mutation.delphi_epistatic()
#Print the values of delta_dict by iteration over sites and bases/residues
for i in range(len(deltas)):
for res in deltas[i]:
print(i + 1, res, deltas[i][res])
#Note: we added 1 to i to count sites starting from one instead of zero.
We can also pass parameters such as the number of iterations, the number of threads for parallel execution, and so on, as
keyword arguments to the PointMutation constructor:
point_mutation = PointMutation(msa_file, biomolecule,
max_iterations = 1000,
num_threads = 4,
seqid = 0.9,
lambda_J = 10.0,
lambda_h = 5.0,
verbose = True
)
where max_iterations is the number of maximum iterations for gradient descent, num_threads is the number of
threads for parallel execution, seqid is the sequence identity threshold value (if sequences have similarity more than this value, they are regarded as the same), lambda_J and lambda_h are penalizing constants for L2 regularization. If verbose is set to True, logging information is enabled.
Preprocessing input MSAs
The input data for pycofitness is an MSA file in FASTA format. We chose not to include tools to generate MSA in pycofitness because, in this way, users can employ their favorite MSA alignment and curation methods. There is only one compulsory adjustment within the input MSA: the sequence to mutate (the reference sequence) has to be positioned as the first one in the MSA. Note that pycofitness automatically removes MSA columns containing non-standard residues and gaps at the reference sequence.
Results interpretation
Here a few line example of pycofitness output file:
#site reference alternative score
1 M A -0.14
1 M C -3.54
1 M D -5.12
1 M E -7.64
....
....
The first column is the position in the reference sequence, the second column is the wild type aminoacid and the third one is the subsituted one. Finally in the last column the pycofitness score is provided. Negative values of this score correspond to variants that are less fit with respect of the wild type protein while positive value means that they are more fit than wilt type.
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
File details
Details for the file pycofitness-1.1.tar.gz.
File metadata
- Download URL: pycofitness-1.1.tar.gz
- Upload date:
- Size: 44.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d83323f94c19dd0b8f50b2e24991907d08acef6b7c858a8bf5dd44842255f4f
|
|
| MD5 |
4fd5c6f5288d7e710c0b516395148390
|
|
| BLAKE2b-256 |
08ec108caad80b572abd2d75e1a1283ba600546f37225391bf8490062ac43553
|