phagetrix


Namephagetrix JSON
Version 0.2.3 PyPI version JSON
download
home_pagehttps://github.com/retospect/phagetrix
SummaryOptimizer for degenerate codon use in phage library generation
upload_time2023-03-14 16:25:39
maintainer
docs_urlNone
authorReto Stamm
requires_python
licenseGPL-3
keywords example
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Phagetrix

[![Open in Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/retospect/phagetrix/blob/main/examples/phagetrix.ipynb)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7676572.svg)](https://doi.org/10.5281/zenodo.7676572)
[![PyPI version](https://badge.fury.io/py/phagetrix.svg)](https://badge.fury.io/py/phagetrix)
[![Action Status](https://github.com/retospect/phagetrix/actions/workflows/check.yml/badge.svg)](https://github.com/retospect/phagetrix/actions/workflows/check.yml)

A codon optimizer for
[phage display library](<https://bio.libretexts.org/Bookshelves/Biochemistry/Supplemental_Modules_(Biochemistry)/4._Biotechnology_2/4.3%3A_M13_Phage_Display_Libraries>)
generation.

When making phage display libraries, it's easy to run out of permutations. 1
liter of phage solution can hold about $10^{12}$ different sequences.

We can approximate how many combinations we generate with 
$(nr\ of\ choices)^{(nr\ of\ positions)}$. 
If we change the aminoacids to "any" aminoacid, we can change about 9 AA's: 
$20^9 \\approx 10^{12}$ permutations.

If we use the degenerate codon capabilities of the manufactureres such as
[IDT](<https://www.idtdna.com/pages/support/faqs/what-are-the-base-degeneracy-codes-that-you-use-(eg.-r-w-k-v-s)->)
to the fullest, we can probably make combinations that are partially rational,
and allow for 6 permutations in any postion.

That allows us to check out many more combinations that are likely to work:
$6^{15} \\approx 10^{12}$, so about 15 variable AA's instead of 9.

This tool allows you to easily specify what AA permutations you want, in which
position, and calculates the best sequence of degenerate codons.

## Example

Phagetrix is a tool to generate phage display libraries. You probably have an
idea what AA's you want to replace, and what you want to replace them with. The
sequence companies have a reasonable number of The file format has the AA
sequence on the first line. Each following line is the AA to be changed, the
digits indicating its position, and the AA options that should be generated for
that position. The AA options are concatenated together with no spaces.
Phagetrix will generate the best degenerate codon for each position.

Example:

```txt
VLAYMVAQVQ
A3AGVIL
Y4YFW
A7AVIL
```

1. The first line is the sequence you want to alter.
1. The P in position 3 should be either a P, F, Y or an A
1. The Y in position 4 should be either a Y, P, F, or an E
1. The A in position 7 should be either an A, V, I, L or an M

Output:

```txt
phagetrix ./sample.phagetrix
   1   2   3   4   5   6   7   8   9  10
   V   L   A   Y   M   V   A   Q   V   Q
 GTT CTT VBA TDK ATG GTT VYA CAG GTT CAG   degenerate codons
          56  50          67               percentage on target
  1V  1L  1V  1Y  1M  1V  1V  1Q  1V  1Q
          1L  1W          1L
          1I  1F          1I
          1G  --          1A
          1A  1L          --
          --  1C          1T
          2R  1*          1P
          1T
          1P

GTTCTTVBATDKATGGTTVYACAGGTTCAG
```

The lines of the output show:

1. number of the AA on the first line
1. original AA on the second line
1. codon made from degenerate basepairs
1. the percentage of product for this codon that matches what the user specified
1. how many codons code for which aminoacid. The AA below the `--` line are
   off-target codons that were not requested.

- the last line shows the codons made from degenerate basepairs again, in a
  format that can easily be copied and pasted.

By default this uses the degenerate codons from
[IDT](<https://www.idtdna.com/pages/support/faqs/what-are-the-base-degeneracy-codes-that-you-use-(eg.-r-w-k-v-s)->).

## Additional features

Adding a comment of this form to your input file (see the pal.phagetrix file in
the example directory)

```txt
# offset = 20
```

allow the setting of variables - in this case, the first aminoacid will be
numbered 21. This is nice for long sequences where "something in the middle"
needs to be edited.

# Try it

- [![Open in Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/retospect/phagetrix/blob/main/examples/phagetrix.ipynb)
- Install it on your machine `pip install phagetrix` to get the `phagetrix`
  command line tool. Requires python3.

# Related projects

Other projects that are potentially interesting, if you are into this sort of
stuff.

- [Make primers for highly variable genomes](https://github.com/jonas-fuchs/varVAMP)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/retospect/phagetrix",
    "name": "phagetrix",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "example",
    "author": "Reto Stamm",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c3/40/3af46c46a978e93edffe8970d0baba335f0f50b54cfce140026b6407809d/phagetrix-0.2.3.tar.gz",
    "platform": null,
    "description": "# Phagetrix\n\n[![Open in Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/retospect/phagetrix/blob/main/examples/phagetrix.ipynb)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7676572.svg)](https://doi.org/10.5281/zenodo.7676572)\n[![PyPI version](https://badge.fury.io/py/phagetrix.svg)](https://badge.fury.io/py/phagetrix)\n[![Action Status](https://github.com/retospect/phagetrix/actions/workflows/check.yml/badge.svg)](https://github.com/retospect/phagetrix/actions/workflows/check.yml)\n\nA codon optimizer for\n[phage display library](<https://bio.libretexts.org/Bookshelves/Biochemistry/Supplemental_Modules_(Biochemistry)/4._Biotechnology_2/4.3%3A_M13_Phage_Display_Libraries>)\ngeneration.\n\nWhen making phage display libraries, it's easy to run out of permutations. 1\nliter of phage solution can hold about $10^{12}$ different sequences.\n\nWe can approximate how many combinations we generate with \n$(nr\\ of\\ choices)^{(nr\\ of\\ positions)}$. \nIf we change the aminoacids to \"any\" aminoacid, we can change about 9 AA's: \n$20^9 \\\\approx 10^{12}$ permutations.\n\nIf we use the degenerate codon capabilities of the manufactureres such as\n[IDT](<https://www.idtdna.com/pages/support/faqs/what-are-the-base-degeneracy-codes-that-you-use-(eg.-r-w-k-v-s)->)\nto the fullest, we can probably make combinations that are partially rational,\nand allow for 6 permutations in any postion.\n\nThat allows us to check out many more combinations that are likely to work:\n$6^{15} \\\\approx 10^{12}$, so about 15 variable AA's instead of 9.\n\nThis tool allows you to easily specify what AA permutations you want, in which\nposition, and calculates the best sequence of degenerate codons.\n\n## Example\n\nPhagetrix is a tool to generate phage display libraries. You probably have an\nidea what AA's you want to replace, and what you want to replace them with. The\nsequence companies have a reasonable number of The file format has the AA\nsequence on the first line. Each following line is the AA to be changed, the\ndigits indicating its position, and the AA options that should be generated for\nthat position. The AA options are concatenated together with no spaces.\nPhagetrix will generate the best degenerate codon for each position.\n\nExample:\n\n```txt\nVLAYMVAQVQ\nA3AGVIL\nY4YFW\nA7AVIL\n```\n\n1. The first line is the sequence you want to alter.\n1. The P in position 3 should be either a P, F, Y or an A\n1. The Y in position 4 should be either a Y, P, F, or an E\n1. The A in position 7 should be either an A, V, I, L or an M\n\nOutput:\n\n```txt\nphagetrix ./sample.phagetrix\n   1   2   3   4   5   6   7   8   9  10\n   V   L   A   Y   M   V   A   Q   V   Q\n GTT CTT VBA TDK ATG GTT VYA CAG GTT CAG   degenerate codons\n          56  50          67               percentage on target\n  1V  1L  1V  1Y  1M  1V  1V  1Q  1V  1Q\n          1L  1W          1L\n          1I  1F          1I\n          1G  --          1A\n          1A  1L          --\n          --  1C          1T\n          2R  1*          1P\n          1T\n          1P\n\nGTTCTTVBATDKATGGTTVYACAGGTTCAG\n```\n\nThe lines of the output show:\n\n1. number of the AA on the first line\n1. original AA on the second line\n1. codon made from degenerate basepairs\n1. the percentage of product for this codon that matches what the user specified\n1. how many codons code for which aminoacid. The AA below the `--` line are\n   off-target codons that were not requested.\n\n- the last line shows the codons made from degenerate basepairs again, in a\n  format that can easily be copied and pasted.\n\nBy default this uses the degenerate codons from\n[IDT](<https://www.idtdna.com/pages/support/faqs/what-are-the-base-degeneracy-codes-that-you-use-(eg.-r-w-k-v-s)->).\n\n## Additional features\n\nAdding a comment of this form to your input file (see the pal.phagetrix file in\nthe example directory)\n\n```txt\n# offset = 20\n```\n\nallow the setting of variables - in this case, the first aminoacid will be\nnumbered 21. This is nice for long sequences where \"something in the middle\"\nneeds to be edited.\n\n# Try it\n\n- [![Open in Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/retospect/phagetrix/blob/main/examples/phagetrix.ipynb)\n- Install it on your machine `pip install phagetrix` to get the `phagetrix`\n  command line tool. Requires python3.\n\n# Related projects\n\nOther projects that are potentially interesting, if you are into this sort of\nstuff.\n\n- [Make primers for highly variable genomes](https://github.com/jonas-fuchs/varVAMP)\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "Optimizer for degenerate codon use in phage library generation",
    "version": "0.2.3",
    "split_keywords": [
        "example"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "91c6ce2d4f48949757fd541b3772c7aaf7b7a7543816b7ffa167bd84342a9ca8",
                "md5": "077a531661fc543e7d318d3fa4b3f4a1",
                "sha256": "9fbfb83adf5f101909379ab82b57ab23a166f08d0ecaa8eecfff87a2be05027e"
            },
            "downloads": -1,
            "filename": "phagetrix-0.2.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "077a531661fc543e7d318d3fa4b3f4a1",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 20489,
            "upload_time": "2023-03-14T16:25:38",
            "upload_time_iso_8601": "2023-03-14T16:25:38.360296Z",
            "url": "https://files.pythonhosted.org/packages/91/c6/ce2d4f48949757fd541b3772c7aaf7b7a7543816b7ffa167bd84342a9ca8/phagetrix-0.2.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c3403af46c46a978e93edffe8970d0baba335f0f50b54cfce140026b6407809d",
                "md5": "b884413e3c3dc39bd50997e085001b00",
                "sha256": "92157efecb47ed7a5fb7ef995467f0fde9dbf0e39f81bd908aa732b5a7a79d0a"
            },
            "downloads": -1,
            "filename": "phagetrix-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "b884413e3c3dc39bd50997e085001b00",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 19097,
            "upload_time": "2023-03-14T16:25:39",
            "upload_time_iso_8601": "2023-03-14T16:25:39.555658Z",
            "url": "https://files.pythonhosted.org/packages/c3/40/3af46c46a978e93edffe8970d0baba335f0f50b54cfce140026b6407809d/phagetrix-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-14 16:25:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "retospect",
    "github_project": "phagetrix",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "phagetrix"
}
        
Elapsed time: 0.14017s