Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,65 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: cc-by-nc-4.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-nc-4.0
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
# Protein2PAM models and training data
|
| 6 |
+
|
| 7 |
+
## Overview
|
| 8 |
+
This repo contains Protein2PAM models and training data.
|
| 9 |
+
|
| 10 |
+
For Python API, see:
|
| 11 |
+
|
| 12 |
+
- GitHub repo: https://github.com/Profluent-AI/protein2pam
|
| 13 |
+
- Zenodo archive: https://zenodo.org/records/17843038
|
| 14 |
+
|
| 15 |
+
## Model Summary
|
| 16 |
+
PAM prediction models for CRISPR-Cas nucleases.
|
| 17 |
+
|
| 18 |
+
### Main Models
|
| 19 |
+
|
| 20 |
+
| Model Name | Input Protein/Domain | CRISPR Type | Samples |
|
| 21 |
+
|-------------------|---------------------|-----------------|----------|
|
| 22 |
+
| `cas8` | Cas8 or Cas10d | Type I | 28,410 |
|
| 23 |
+
| `cas9` | Cas9 PI-domain | Type II | 15,843 |
|
| 24 |
+
| `cas12` | Cas12 protein | Type V | 1,720 |
|
| 25 |
+
|
| 26 |
+
### Additional Models
|
| 27 |
+
|
| 28 |
+
| Model Name | Input Protein/Domain | CRISPR Type | Samples |
|
| 29 |
+
|------------------|----------------------|-------------|---------|
|
| 30 |
+
| `cas9_full` | Cas9 protein | Type II | 15,843 |
|
| 31 |
+
| `cas9_full_nolit` | Cas9 protein | Type II | 15,731 |
|
| 32 |
+
| `cas9_pid_nolit` | Cas9 PI-domain | Type II | 15,731 |
|
| 33 |
+
| `cas9_pid_nme` | Cas9 PI-domain | Type II | 15,843 |
|
| 34 |
+
| `cas12_no_lit` | Cas12 protein | Type V | 1,675 |
|
| 35 |
+
|
| 36 |
+
|
| 37 |
+
## Dataset Summary
|
| 38 |
+
|
| 39 |
+
Training data is stored in: `Profluent-Bio/protein2pam-training-data`
|
| 40 |
+
|
| 41 |
+
### Data Fields
|
| 42 |
+
|
| 43 |
+
| Field name | Description | Data type | Example |
|
| 44 |
+
|-------------------|--------------------------------------------------------|---------------------------|---------|
|
| 45 |
+
| cas_family | CRISPR-Cas family classification | string | Cas8 |
|
| 46 |
+
| source | Data source ('CRISPR-Cas Atlas' or Literature') | string | CRISPR-Cas Atlas |
|
| 47 |
+
| protein_id | Identifier for literature sequences | string or null | null |
|
| 48 |
+
| citation | Literature citation(s) | string or null | null |
|
| 49 |
+
| doi | DOI for the associated publication | string or null | null |
|
| 50 |
+
| protein_sequence | Full amino acid sequence | string | MTFMILQALYRY...NQN |
|
| 51 |
+
| pid_sequence | PAM-interacting domain sequence (Cas9 only) | string or null | null |
|
| 52 |
+
| pam_consensus | Consensus PAM sequence | string | TTC |
|
| 53 |
+
| pam_logo_acgt | ACGT-ordered numerical matrix for PAM logo | array of float arrays | [[0.005, 0.008, 0.007, 0.01], ...] |
|
| 54 |
+
| type | CRISPR-Cas type classification | string | Type I |
|
| 55 |
+
| subtype | CRISPR-Cas subtype or effector family | string | Cas8 |
|
| 56 |
+
|
| 57 |
+
|
| 58 |
+
## Licensing
|
| 59 |
+
|
| 60 |
+
Models and data are licensed under the [Creative Commons Attribution–NonCommercial 4.0 International (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/). You may share and adapt the models for non-commercial use with appropriate attribution.
|
| 61 |
+
|
| 62 |
+
|
| 63 |
+
## Citation
|
| 64 |
+
If you use Protein2PAM in your research, please cite the following preprint:
|
| 65 |
+
[Nayfach, S., Bhatnagar, A., Novichkov, A., et al. (2025). Engineering of CRISPR-Cas PAM recognition using deep learning of vast evolutionary data. bioRxiv.](https://www.biorxiv.org/content/10.1101/2025.01.06.631536v1)
|