Giter VIP home page Giter VIP logo

dimple's Introduction

Open In Colab

DIMPLE: Deep Indel Missense Programmable Library Engineering

Protein domain insertion via programmed oligo libraries

Python script for generating oligo libraries and PCR primers for programmed domain insertion
Paper is linked here: (https://genomebiology.biomedcentral.com/articles/10.1186/s13059-023-02880-6) and here: (https://www.biorxiv.org/content/10.1101/2022.07.26.501589v1.full.pdf)

License

This code is licensed under the terms of the MIT license: License

How to run the program to generate oligos and primers

Use Google Colab without downloading or installing on your computer
Run with a command line in terminal with the listed options below
Run with the GUI that uses tkinter

Data Formats

Targeted genes must be in fasta format and include the entire plasmid sequence to search for nonspecific amplification
Final output is fasta format. One file for oligo pools and one file for PCR primers

Position arguments

Gene start is defined as base number of first base in first codon and gene end is defined as base number of last base in last codon. (Program will subtract 1 from gene start for python numbering)

To define gene position within given fasta file, add start:# end:# to fasta description. (Otherwise use command line prompts)
'>geneA start:11 end:40'

Running Test

Deep Mutational Scanning with amino acid subsitution with stop codons and ecoli codon usage, GGG insertion, 3 base deletion, and BsaI golden gate:
python run_dimple.py -wDir tests -geneFile combined_fasta.fa -oligoLen 230 -DMS -usage ecoli -include_stop_codons -restriction_sequence GGTCTC(G)1/5 -avoid_sequence GGTCTC -insertions GGG -deletions 3

Commandline Usage

options:
  -h, --help            show this help message and exit
  -wDir WDIR            Working directory for fasta files and output folder
  -geneFile GENEFILE    Input all gene sequences including backbone in a fasta format. Place all in one fasta file.
                        Name description can include start and end points (>gene1 start:1 end:2)
  -handle HANDLE        Genetic handle for domain insertion. This is important for defining the linker. Currently
                        uses BsaI (4 base overhang), but this can be swapped for SapI (3 base overhang).
  -dis DIS              use the handle to insert domains at every position in POI
  -matchSequences       Find similar sequences between genes to avoid printing the same oligos multiple times.
                        Default: No matching
  -oligoLen OLIGOLEN    Synthesized oligo length
  -fragmentLen FRAGMENTLEN
                        Maximum length of gene fragment
  -overlap OVERLAP      Enter number of bases to extend each fragment for overlap. This will help with insertions
                        close to fragment boundary
  -DMS                  Choose if you will run deep deep mutation scan
  -custom_mutations CUSTOM_MUTATIONS
                        Path to file that includes custom mutations with the format position:AA
  -usage USAGE          Default is "human". Or select "ecoli. Or change code"
  -insertions INSERTIONS [INSERTIONS ...]
                        Enter a list of insertions (nucleotides) to make at every position. Note, you should enter
                        multiples of 3 nucleotides to maintain reading frame
  -deletions DELETIONS [DELETIONS ...]
                        Enter a list of deletions (number of nucleotides) to symmetrically delete (it will make
                        deletions in multiples of 2x). Note you should enter multiples of 3 to maintain reading
                        frame
  -include_substitutions INCLUDE_SUBSTITUTIONS
                        If you are running DMS but only want to insert or delete AA
  -barcode_start BARCODE_START
                        To run DIMPLE multiple times, you will need to avoid using the same barcodes. This allows
                        you to start at a different barcode.
  -restriction_sequence RESTRICTION_SEQUENCE
                        Recommended using BsmBI - CGTCTC(G)1/5 or BsaI - GGTCTC(G)1/5
  -avoid_sequence AVOID_SEQUENCE [AVOID_SEQUENCE ...]
                        Avoid these sequences in the backbone - BsaI and BsmBI. For multiple sequnces use a space
                        between inputs. Example -avoid_sequence CGTCTC GGTCTC
  -include_stop_codons  Include stop codons in the list of scanning mutations.
  -include_synonymous   Include synonymous codons in the list of scanning mutations.
  -make_double          Make each combination of mutations within a fragment

GUI Usage

Run the GUI with the commandline prompt: python run_dimple_gui.py

DIMPLE_GUI

You must select:
  -Target Gene File - select fasta file with name description including start and end points (>gene1 start:1 end:2)
  -One or more of the mutations to make to the target gene
  
 Run the program by pressing Run DIMPLE

dimple's People

Contributors

nedru004 avatar coywil26 avatar calbect avatar odcambc avatar

Stargazers

 avatar  avatar Matthew K. Howard avatar Sook Wah Yee avatar Akos Nyerges avatar  avatar alematia avatar  avatar

Watchers

 avatar  avatar Yarrow Madrona avatar

dimple's Issues

error in test example

I was trying to run test example python run_dimple.py -wDir tests -geneFile combined_fasta.fa -oligoLen 230 -DMS -usage ecoli -include_stop_codons -restriction_sequence GGTCTC -avoid_sequence GGTCTC -insertions GGG -deletions 3 and I'm getting the following error:

Traceback (most recent call last):
  File "2024/DIMPLE/run_dimple.py", line 62, in <module>
    DIMPLE.cutsite_buffer = Seq(tmp_cutsite[1].split(')')[0])
                                ~~~~~~~~~~~^^^
IndexError: list index out of range

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.