<!-- README.md is generated from README.Rmd. Please edit that file -->
# deepdirect
<!-- badges: start -->
<!-- badges: end -->
Deepdirect is an in silico approach to generate mutations for protein
complexes towards a specified direction (increase/decrease) in binding
affinity.
## System requirements and dependencies
### Hardware Requirements
`deepdirect` model is able to be trained and perform its operations on a
standard computer.
### OS Requirements
The `deepdirect` model should be compatible with Windows, Mac, and Linux
operating systems. The package has been tested on the following systems:
- Linux 3.10.0
- Windows 10
### Dependencies
`deepdirect` framework is built and trained on the `Tensorflow 2.4.0`
and `Keras 2.4.0`.
## Framework construction
The python file including all required deepdirect framework built
function is able to be downloaded from GitHub:
`deepdirect_framework/model_function.py`
## Data structure
- `data` folder contains the original datasets used for building the
training datasets.
- `deepdirect_framework` folder contains the trained model weights and
the model constructing functions.
- `deepdirect_paper` folder contains codes for building and training
models, and performing analysis in the deepdirect manuscript. The file
`ab_bind_data_extract.py` and `skempi_data_extract.py` contains code
for constructing training datasets for Deepdirect framework.
`train_step_1.py` contains code for training step 1 for the mutation
mutator. `final_model.py` contains code for training step 2 (final)
for the mutation mutator. `model_function.py` contains code for
constructing the Deepdirect framework.
`model_evaluation_application.py` contains code for model evaluation,
and teh application on Novavax-vaccine. `evolution_analysis.py`
contains code for performing evolution analysis.
## File source
For files that are required as input in the code but not generated from
other codes, please refer to the data availability section in the
original paper.
## Installation
Clone repository:
git clone https://github.com/tianlt/deepdirect.git
Create virtual environment:
conda create --name deepdirect python=3.6.8
Activate virtual environment:
conda activate deepdirect
Install dependencies:
pip install tensorflow==2.4.0
pip install keras==2.4.0
## Running deepdirect
### data processing
Data to be input to deepdirect include sequence to be mutated `pre`, RBD
site `rbd`, ligand-receptor index `same`, protein tertiary structure
information `x`, `y` and `z`, and random noise `input_noi`. All input
has to be `tf.float32` type.
### Build deepdirect mutator with trained weights
aa_mutator = build_aa_mutator()
aa_mutator.load_weights(
'deepdirect_framework/model_i_weights.h5')
### Binding affinity-guided mutation
aa_mutator.predict([pre, rbd, same, x, y, z, input_noi])
### Additional information
Expected outputs: mutated amino acid sequence
Expected runtime for mutation: ~1 mintue
## Issues and bug reports
Please use <https://github.com/tianlt/deepdirect/issues> to submit
issues, bug reports, and comments.
## License
deepdirect is distributed under the [GNU General Public License version
2 (GPLv2)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).
Metadata
Release files for deepdirect 0.2.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| deepdirect-0.2.5.tar.gz | 7.4 MB | Without provenance | Details for deepdirect-0.2.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| deepdirect-0.2.5-py3-none-any.whl | Python 3 | none | any | Details for deepdirect-0.2.5-py3-none-any.whl |
Total release size: 14.8 MB
Release files / deepdirect-0.2.5.tar.gz
| Download URL | deepdirect-0.2.5.tar.gz |
|---|---|
| Size | 7.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ab41f3f53161193146681d477f2412ebdb663bbf76c350e195a05efbb9f032dc
|
|
BLAKE2b-256 checksum How to use checksums |
4c41cf2f8a692bd7a3aaac31abcfc423367a325939ce13d58924219bd157dfcb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Release files / deepdirect-0.2.5-py3-none-any.whl
| Download URL | deepdirect-0.2.5-py3-none-any.whl |
|---|---|
| Size | 7.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e2fb76b067198e76ac1c2336a4a86c155d9b5a592d7c91e9194288c7e2528bb7
|
|
BLAKE2b-256 checksum How to use checksums |
93279080cabd833ec6f107d4b361d6ca392a2596e5904f6339ef5c2b0937e8e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Security for deepdirect 0.2.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.