This is used for automatically designing gRNAs for genome editing by Target-AID.
Project description
KOnezumi-AID
KOnezumi-AID is the command-line tool to automate the gRNA design for multiplex KO mouse using Target-AID
Installation
Prerequisits
- Python 3.9 or later
- Unix-like environment (Linux, macOS, WSL2, etc.)
Installation🔨
From Bioconda (Recommended)
conda install -c conda-forge -c bioconda konezumiaid
From PyPI:
pip install KOnezumiAID
Required Packages (Not needed if installed via Bioconda)
-
bedtools
Follow the official instruction -
bowtie
Follow the official instruction
[!NOTE] TI Apple silicon (ARM64) users:
Since the Bioconda channel does not yet support Apple Silicon, please use the following command to installKOnezumi-AID.CONDA_SUBDIR=osx-64 conda create -n env-konezumiaid -c conda-forge -c bioconda python=3.10 konezumiaid -y conda activate env-konezumiaid conda config --env --set subdir osx-64 python -c "import platform; print(platform.machine())" # Confirm that the output is 'x86_64', not 'arm64'
Input data set (e.g. Mus musculus mm39)
Locus information
refFlat.txt.gz from UCSC
genomic sequence
mm39.fa.gz from UCSC
Download scripts (bash)
mkdir -p data
curl https://hgdownload.soe.ucsc.edu/goldenPath/mm39/database/refFlat.txt.gz |
gzip -dc > data/refFlat.txt
curl https://hgdownload.soe.ucsc.edu/goldenPath/mm39/bigZips/mm39.fa.gz |
gzip -dc > data/mm39.fa
Usage
KOnezumi-AID's output
- gRNAs to generate PTC (premature termination codon)
- gRNAs to disrupt splice acceptor site
- gRNAs to disrupt splice donor site
KOnezumi-AID provides these gRNAs in standerd output and CSV format.
The CSV file is located in data/output directory and named as <gene symbol/transcript name>_ptc_gRNA.csv or <gene symbol/transcript name>_splice_gRNA.csv.
Create data set for KOnezumi-AID
konezumiaid preprocess <your refFlat.txt Path> <your mm39.fa Path>
Example
konezumiaid preprocess data/refFlat.txt data/mm39.fa
Search candidate by gene symbol or transcript name (Refseq id)
KOnezumi-AID accepts a gene symbol or a transcript name.
konezumiaid <-n | --name> <gene symbol | transcript name>
Search by gene symbol
You can obtain the gRNAs that are present in all transcript variants.
[!NOTE]
If the gene has one transcript, the result is the same as searching by the transcript name
Search by transcript name
You can obtain the transcript's gRNAs and access more information about the gRNAs.
- in_start_150bp: The gRNA is located in the first 150bp of the transcript or not.
- in_50bp_from_LEJ: The gRNA is located in the 50bp from the last exon junction or not.
- exon_index: the index of the exon where the gRNA is located.
Examples
Search candidate by the gene symbol (gene symbol with multiple transcripts)
$konezumiaid -n Rp1
Processing NM_001370921...
Processing NM_001195662...
Processing NM_011283...
List of gRNAs to generate PTC (premature termination codon)
Target sequence (20mer + PAM) Target amino acid link to CRISPRdirect
0 ACAGTTTGGCGGCGTTCGGGTGG Q https://crispr.dbcls.jp/?userseq=ACAGTTTGGCGGCGTTCGGGTGG&pam=NGG&db=mm39
1 ACGACACAGCATCACCAGGCTGG R https://crispr.dbcls.jp/?userseq=ACGACACAGCATCACCAGGCTGG&pam=NGG&db=mm39
2 ACAGGTTATGCAGTGTCCTGTGG Q https://crispr.dbcls.jp/?userseq=ACAGGTTATGCAGTGTCCTGTGG&pam=NGG&db=mm39
3 CCAGGGCCGAGGGCGCCTGCGGG W https://crispr.dbcls.jp/?userseq=CCAGGGCCGAGGGCGCCTGCGGG&pam=NGG&db=mm39
4 GCCAGGGCCGAGGGCGCCTGCGG W https://crispr.dbcls.jp/?userseq=GCCAGGGCCGAGGGCGCCTGCGG&pam=NGG&db=mm39
List of gRNAs to disrupt splice acceptor site
No gRNA found.
List of gRNAs to disrupt splice donor site
No gRNA found.
Search candidate by the gene symbol (gene symbol with single transcript)
$konezumiaid -n Mafa
List of gRNAs to generate PTC (premature termination codon)
Target sequence (20mer + PAM) Recommended Target amino acid link to CRISPRdirect
0 CTCAGGCCGGGGGCGCCCCGGGG True 87Q https://crispr.dbcls.jp/?userseq=CTCAGGCCGGGGGCGCCCCGGGG&pam=NGG&db=mm39
1 GCTCAGGCCGGGGGCGCCCCGGG True 87Q https://crispr.dbcls.jp/?userseq=GCTCAGGCCGGGGGCGCCCCGGG&pam=NGG&db=mm39
2 CCAGCACCACCTGAACCCCGAGG True 121Q https://crispr.dbcls.jp/?userseq=CCAGCACCACCTGAACCCCGAGG&pam=NGG&db=mm39
3 GGTCAGAGCTTCGCGGGCGGCGG True 167Q https://crispr.dbcls.jp/?userseq=GGTCAGAGCTTCGCGGGCGGCGG&pam=NGG&db=mm39
List of gRNAs to disrupt splice acceptor site
No gRNA found.
List of gRNAs to disrupt splice donor site
No gRNA found.
Search candidate by the transcript name
$ konezumiaid -n NM_001370921
List of gRNAs to generate PTC (premature termination codon)
Target sequence (20mer + PAM) Recommended Target amino acid link to CRISPRdirect
0 ACAGTTTGGCGGCGTTCGGGTGG False 46Q https://crispr.dbcls.jp/?userseq=ACAGTTTGGCGGCGTTCGGGTGG&pam=NGG&db=mm39
1 ACGACACAGCATCACCAGGCTGG True 88R https://crispr.dbcls.jp/?userseq=ACGACACAGCATCACCAGGCTGG&pam=NGG&db=mm39
2 ACAGGTTATGCAGTGTCCTGTGG True 192Q https://crispr.dbcls.jp/?userseq=ACAGGTTATGCAGTGTCCTGTGG&pam=NGG&db=mm39
3 ACAACCTGTCCTTCCAGGTAAGG True 389Q https://crispr.dbcls.jp/?userseq=ACAACCTGTCCTTCCAGGTAAGG&pam=NGG&db=mm39
4 ACCAATCAGAACAATCCCACTGG True 698Q https://crispr.dbcls.jp/?userseq=ACCAATCAGAACAATCCCACTGG&pam=NGG&db=mm39
5 ACGAATGTATCTGAGGATTAAGG True 723R https://crispr.dbcls.jp/?userseq=ACGAATGTATCTGAGGATTAAGG&pam=NGG&db=mm39
6 TCAGGCCAATGTCACATTGTGGG True 861Q https://crispr.dbcls.jp/?userseq=TCAGGCCAATGTCACATTGTGGG&pam=NGG&db=mm39
7 CTCAGGCCAATGTCACATTGTGG True 861Q https://crispr.dbcls.jp/?userseq=CTCAGGCCAATGTCACATTGTGG&pam=NGG&db=mm39
8 CCAGGGCCGAGGGCGCCTGCGGG True 126W https://crispr.dbcls.jp/?userseq=CCAGGGCCGAGGGCGCCTGCGGG&pam=NGG&db=mm39
9 GCCAGGGCCGAGGGCGCCTGCGG True 126W https://crispr.dbcls.jp/?userseq=GCCAGGGCCGAGGGCGCCTGCGG&pam=NGG&db=mm39
10 TCCAGTGGGATTGTTCTGATTGG True 704W https://crispr.dbcls.jp/?userseq=TCCAGTGGGATTGTTCTGATTGG&pam=NGG&db=mm39
11 CCAGTACTGGGATTTGTCACTGG True 1052W https://crispr.dbcls.jp/?userseq=CCAGTACTGGGATTTGTCACTGG&pam=NGG&db=mm39
List of gRNAs to disrupt splice acceptor site
Target sequence (20mer + PAM) Exon index link to CRISPRdirect
0 ACCTGGGATTGAAAGGAACAAGG 20 https://crispr.dbcls.jp/?userseq=ACCTGGGATTGAAAGGAACAAGG&pam=NGG&db=mm39
1 TCTGTTGGAGAAAAGCCCCATGG 22 https://crispr.dbcls.jp/?userseq=TCTGTTGGAGAAAAGCCCCATGG&pam=NGG&db=mm39
2 ACCTGAAGAAAATGGAAAACAGG 23 https://crispr.dbcls.jp/?userseq=ACCTGAAGAAAATGGAAAACAGG&pam=NGG&db=mm39
List of gRNAs to disrupt splice donor site
Target sequence (20mer + PAM) Exon index link to CRISPRdirect
0 TACCTTGCCCAAGTCCATCATGG 8 https://crispr.dbcls.jp/?userseq=TACCTTGCCCAAGTCCATCATGG&pam=NGG&db=mm39
1 TTACCTCTCACAGGTGAAGATGG 22 https://crispr.dbcls.jp/?userseq=TTACCTCTCACAGGTGAAGATGG&pam=NGG&db=mm39
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file konezumiaid-0.3.0.tar.gz.
File metadata
- Download URL: konezumiaid-0.3.0.tar.gz
- Upload date:
- Size: 21.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9070074372d1026e04016b9979ca3b5a5a216c7acea3ad333ecb955b6ceb4f36
|
|
| MD5 |
179137934d5896829afac5d4734bbebd
|
|
| BLAKE2b-256 |
a8fceb5b5298f4832d46eae4adfb0bf9251c9cc28bb24a8e7d585102481b54ae
|
File details
Details for the file konezumiaid-0.3.0-py3-none-any.whl.
File metadata
- Download URL: konezumiaid-0.3.0-py3-none-any.whl
- Upload date:
- Size: 29.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b8e8f3e3e850ffc3bbec23be49526ad42426275c1c6c50f23765a3fd002acb4
|
|
| MD5 |
76f92d94a3bf2ef14448e87abfdf2b96
|
|
| BLAKE2b-256 |
52dc12bbe1695c4cbc7fccedd236e8efa8d93d120fbdbda8d1b010288bff4f9d
|