deeplc
DeepLC: Retention time prediction for (modified) peptides using Deep Learning.
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README -
✓Academic publication links
Links to: pubmed.ncbi, ncbi.nlm.nih.gov, acs.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
DeepLC: Retention time prediction for (modified) peptides using Deep Learning.
Basic Info
- Host: GitHub
- Owner: CompOmics
- License: apache-2.0
- Language: Python
- Default Branch: master
- Homepage: https://iomics.ugent.be/deeplc
- Size: 839 MB
Statistics
- Stars: 70
- Watchers: 13
- Forks: 24
- Open Issues: 1
- Releases: 89
Topics
Metadata Files
README.md
DeepLC: Retention time prediction for (modified) peptides using Deep Learning.
Introduction
DeepLC is a retention time predictor for (modified) peptides that employs Deep Learning. Its strength lies in the fact that it can accurately predict retention times for modified peptides, even if hasn't seen said modification during training.
DeepLC can be used through the web application, locally with a graphical user interface (GUI), or as a Python package. In the latter case, DeepLC can be used from the command line, or as a Python module.
Citation
If you use DeepLC for your research, please use the following citation:
DeepLC can predict retention times for peptides that carry as-yet unseen modifications
Robbin Bouwmeester, Ralf Gabriels, Niels Hulstaert, Lennart Martens & Sven Degroeve
Nature Methods 18, 13631369 (2021) doi: 10.1038/s41592-021-01301-5
Usage
Web application
Just go to iomics.ugent.be/deeplc and get started!
Graphical user interface
In an existing Python environment (cross-platform)
- In your terminal with Python (>=3.7) installed, run
pip install deeplc[gui] - Start the GUI with the command
deeplc-guiorpython -m deeplc.gui
Standalone installer (Windows)
- Download the DeepLC installer (
DeepLC-...-Windows-64bit.exe) from the latest release - Execute the installer
- If Windows Smartscreen shows a popup window with "Windows protected your PC", click on "More info" and then on "Run anyway". You will have to trust us that DeepLC does not contain any viruses, or you can check the source code
- Go through the installation steps
- Start DeepLC!

Python package
Installation
Install with conda, using the bioconda and conda-forge channels:
conda install -c bioconda -c conda-forge deeplc
Or install with pip:
pip install deeplc
Command line interface
To use the DeepLC CLI, run:
sh
deeplc --file_pred <path/to/peptide_file.csv>
We highly recommend to add a peptide file with known retention times for calibration:
sh
deeplc --file_pred <path/to/peptide_file.csv> --file_cal <path/to/peptide_file_with_tr.csv>
For an overview of all CLI arguments, run deeplc --help.
Python module
Minimal example:
```python import pandas as pd from deeplc import DeepLC
peptidefile = "datasets/testpred.csv" calibrationfile = "datasets/testtrain.csv"
pepdf = pd.readcsv(peptidefile, sep=",") pepdf['modifications'] = pep_df['modifications'].fillna("")
caldf = pd.readcsv(calibrationfile, sep=",") caldf['modifications'] = cal_df['modifications'].fillna("")
dlc = DeepLC() dlc.calibratepreds(seqdf=caldf) preds = dlc.makepreds(seqdf=pepdf) ```
Minimal example with psm_utils:
```python import pandas as pd
from psmutils.psm import PSM from psmutils.psmlist import PSMList from psmutils.io import write_file
from deeplc import DeepLC
infile = pd.readcsv("https://github.com/compomics/DeepLC/files/13298024/231108DeepLCinput-peptides.csv") psmlist = []
for idx,row in infile.iterrows(): seq = row["modifications"].replace("(","[").replace(")","]")
if seq.startswith("["):
idx_nterm = seq.index("]")
seq = seq[:idx_nterm+1]+"-"+seq[idx_nterm+1:]
psm_list.append(PSM(peptidoform=seq,spectrum_id=idx))
psmlist = PSMList(psmlist=psm_list)
infile = pd.readcsv("https://github.com/compomics/DeepLC/files/13298022/231108DeepLCinput-calibration-file.csv") psmlist_calib = []
for idx,row in infile.iterrows(): seq = row["seq"].replace("(","[").replace(")","]")
if seq.startswith("["):
idx_nterm = seq.index("]")
seq = seq[:idx_nterm+1]+"-"+seq[idx_nterm+1:]
psm_list_calib.append(PSM(peptidoform=seq,retention_time=row["tr"],spectrum_id=idx))
psmlistcalib = PSMList(psmlist=psmlist_calib)
dlc = DeepLC() dlc.calibratepreds(psmlistcalib) preds = dlc.makepreds(seqdf=psmlist) ```
For a more elaborate example, see examples/deeplc_example.py .
Input files
DeepLC expects comma-separated values (CSV) with the following columns:
seq: unmodified peptide sequencesmodifications: MS2PIP-style formatted modifications: Every modification is listed aslocation|name, separated by a pipe (|) between the location, the name, and other modifications.locationis an integer counted starting at 1 for the first AA. 0 is reserved for N-terminal modifications, -1 for C-terminal modifications.namehas to correspond to a Unimod (PSI-MS) name.tr: retention time (only required for calibration)
For example:
csv
seq,modifications,tr
AAGPSLSHTSGGTQSK,,12.1645
AAINQKLIETGER,6|Acetyl,34.095
AANDAGYFNDEMAPIEVKTK,12|Oxidation|18|Acetyl,37.3765
See examples/datasets for more examples.
Prediction models
DeepLC comes with multiple CNN models trained on data from various experimental settings. By default, DeepLC selects the best model based on the calibration dataset. If no calibration is performed, the first default model is selected. Always keep note of the used models and the DeepLC version. The current version comes with:
| Model filename | Experimental settings | Publication | | - | - | - | | fullhcPXD005573mcp8c22d89667368f2f02ad996469ba157e.hdf5 | Reverse phase | Bruderer et al. 2017 | | fullhcPXD005573mcp1fd8363d9af9dcad3be7553c39396960.hdf5 | Reverse phase | Bruderer et al. 2017 | | fullhcPXD005573mcpcb975cfdd4105f97efa0b3afffe075cc.hdf5 | Reverse phase | Bruderer et al. 2017 |
For all the full models that can be used in DeepLC (including some TMT models!) please see:
https://github.com/RobbinBouwmeester/DeepLCModels
Naming convention for the models is as follows:
[fullhc]_[dataset]_[fixedmods]_[hash].hdf5
The different parts refer to:
full_hc - flag to indicated a finished, trained, and fully optimized model
dataset - name of the dataset used to fit the model (see the original publication, supplementary table 2)
fixed mods - flag to indicate fixed modifications were added to peptides without explicit indication (e.g., carbamidomethyl of cysteine)
hash - indicates different architectures, where "1fd8363d9af9dcad3be7553c39396960" indicates CNN filter lengths of 8, "cb975cfdd4105f97efa0b3afffe075cc" indicates CNN filter lengths of 4, and "8c22d89667368f2f02ad996469ba157e" indicates filter lengths of 2
Q&A
Q: Is it required to indicate fixed modifications in the input file?
Yes, even modifications like carbamidomethyl should be in the input file.
Q: So DeepLC is able to predict the retention time for any modification?
Yes, DeepLC can predict the retention time of any modification. However, if the modification is very different from the peptides the model has seen during training the accuracy might not be satisfactory for you. For example, if the model has never seen a phosphor atom before, the accuracy of the prediction is going to be low.
Q: Installation fails. Why?
Please make sure to install DeepLC in a path that does not contain spaces. Run the latest LTS version of Ubuntu or Windows 10. Make sure you have enough disk space available, surprisingly TensorFlow needs quite a bit of disk space. If you are still not able to install DeepLC, please feel free to contact us:
Robbin.Bouwmeester@ugent.be and Ralf.Gabriels@ugent.be
Q: I have a special usecase that is not supported. Can you help?
Ofcourse, please feel free to contact us:
Robbin.Bouwmeester@ugent.be and Ralf.Gabriels@ugent.be
Q: DeepLC runs out of memory. What can I do?
You can try to reduce the batch size. DeepLC should be able to run if the batch size is low enough, even on machines with only 4 GB of RAM.
Q: I have a graphics card, but DeepLC is not using the GPU. Why?
For now DeepLC defaults to the CPU instead of the GPU. Clearly, because you want to use the GPU, you are a power user :-). If you want to make the most of that expensive GPU, you need to change or remove the following line (at the top) in deeplc.py:
```
Set to force CPU calculations
os.environ['CUDAVISIBLEDEVICES'] = '-1' ```
Also change the same line in the function reset_keras():
```
Set to force CPU calculations
os.environ['CUDAVISIBLEDEVICES'] = '-1' ```
Either remove the line or change to (where the number indicates the number of GPUs):
```
Set to force CPU calculations
os.environ['CUDAVISIBLEDEVICES'] = '1' ```
Q: What modification name should I use?
The names from unimod are used. The PSI-MS name is used by default, but the Interim name is used as a fall-back if the PSI-MS name is not available. It should be fine as long as it is support by proforma and psm_utils.
Q: I have a modification that is not in unimod. How can I add the modification?
Unfortunately since the V3.0 this is not possible any more via the GUI or commandline. You will need to use psm_utils, above a minimal example is shown where we convert an identification file into a psm_list which is accepted by DeepLC. Here the sequence can for example include just the composition in proforma format (e.g., SEQUEN[Formula:C12H20O2]CE).
Q: Help, all my predictions are between [0,10]. Why?
It is likely you did not use calibration. No problem, but the retention times for training purposes were normalized between [0,10]. This means that you probably need to adjust the retention time yourselve after analysis or use a calibration set as the input.
Q: What does the option dict_divider do?
This parameter defines the precision to use for fast-lookup of retention times for calibration. A value of 10 means a precision of 0.1 (and 100 a precision of 0.01) between the calibration anchor points. This parameter does not influence the precision of the calibration, but setting it too high might mean that there is bad selection of the models between anchor points. A safe value is usually higher than 10.
Q: What does the option split_cal do?
The option split_cal, or split calibration, sets number of divisions of the
chromatogram for piecewise linear calibration. If the value is set to 10 the
chromatogram is split up into 10 equidistant parts. For each part the median
value of the calibration peptides is selected. These are the anchor points.
Between each anchor point a linear fit is made. This option has no effect when
the pyGAM generalized additive models are used for calibration.
Q: How does the ensemble part of DeepLC work?
Models within the same directory are grouped if they overlap in their name. The overlap has to be in their full name, except for the last part of the name after a "_"-character.
The following models will be grouped:
full_hc_dia_fixed_mods_a.hdf5
full_hc_dia_fixed_mods_b.hdf5
None of the following models will not be grouped:
full_hc_dia_fixed_mods2_a.hdf5
full_hc_dia_fixed_mods_b.hdf5
full_hc_dia_fixed_mods_2_b.hdf5
Q: I would like to take the ensemble average of multiple models, even if they are trained on different datasets. How can I do this?
Feel free to experiment! Models within the same directory are grouped if they overlap in their name. The overlap has to be in their full name, except for the last part of the name after a "_"-character.
The following models will be grouped:
model_dataset1.hdf5
model_dataset2.hdf5
So you just need to rename your models.
Owner
- Name: Computational Omics and Systems Biology Group
- Login: CompOmics
- Kind: organization
- Email: compomics.list@gmail.com
- Website: https://www.compomics.com/
- Twitter: CompOmics
- Repositories: 93
- Profile: https://github.com/CompOmics
The CompOmics group, headed by Prof. Dr. Lennart Martens, specializes in the management, analysis and integration of high-throughput Omics data.
GitHub Events
Total
- Issues event: 2
- Watch event: 3
- Issue comment event: 2
- Push event: 5
- Fork event: 1
- Create event: 3
Last Year
- Issues event: 2
- Watch event: 3
- Issue comment event: 2
- Push event: 5
- Fork event: 1
- Create event: 3
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| RobbinBouwmeester | R****r@u****e | 153 |
| robbin bouwmeester | r****r@u****e | 106 |
| RalfG | r****g@h****e | 95 |
| Ralf | R****G@h****e | 37 |
| nielshulstaert | n****t@g****m | 13 |
| Kevin Velghe | k****e@u****e | 9 |
| markmipt | m****t@g****m | 3 |
| nielshulstaert | n****t@u****e | 3 |
| Kevin Velghe | k****e@u****e | 2 |
| ArthurDeclercq | A****q@U****e | 1 |
| caetera | h****k@g****m | 1 |
| dependabot[bot] | 4****] | 1 |
| rodvrees | 9****s | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 46
- Total pull requests: 52
- Average time to close issues: about 1 month
- Average time to close pull requests: 12 days
- Total issue authors: 28
- Total pull request authors: 8
- Average comments per issue: 3.46
- Average comments per pull request: 0.04
- Merged pull requests: 47
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 8
- Pull requests: 8
- Average time to close issues: 28 days
- Average time to close pull requests: about 21 hours
- Issue authors: 7
- Pull request authors: 3
- Average comments per issue: 4.0
- Average comments per pull request: 0.0
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- markmipt (5)
- vrkosk (4)
- RalfG (4)
- KarlClauser (3)
- MarcIsak (3)
- steffenlem (3)
- HR-RH (2)
- WeiqiangChen (2)
- chinmayaNK22 (1)
- candidaorelmex (1)
- likun1212 (1)
- AlexanderMoysa (1)
- DongElkan (1)
- f-huber (1)
- sehooni (1)
Pull Request Authors
- RalfG (31)
- RobbinBouwmeester (12)
- paretje (5)
- markmipt (2)
- Alirezak2n (2)
- ArthurDeclercq (1)
- dependabot[bot] (1)
- caetera (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 1,146 last-month
- Total dependent packages: 2
- Total dependent repositories: 1
- Total versions: 115
- Total maintainers: 4
pypi.org: deeplc
DeepLC: Retention time prediction for (modified) peptides using Deep Learning.
- Documentation: https://deeplc.readthedocs.io/
- License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
Latest release: 3.1.13
published 6 months ago
Rankings
Maintainers (4)
Dependencies
- actions/checkout v2 composite
- actions/download-artifact v2 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite
- crazy-max/ghaction-chocolatey v1 composite
- docker/build-push-action v2 composite
- docker/login-action v1 composite
- docker://antonyurchenko/git-release v4 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- pandas
- pip
- plotly
- python 3.8.*
- statsmodels
- streamlit >=0.88
- tensorflow
- continuumio/miniconda3 4.9.2 build
- debian buster-slim build
- h5py >=2.10.0,<4
- matplotlib >=3,<4
- numpy >=1.17,<2
- pandas >=0.25,<2
- pygam >=0.8.0,<1
- scikit-learn >=0.24.0,<2
- scipy >=1.4.1,<2
- setuptools >=42.0.1
- tensorflow >=2.2,<3