python-codon-tables


Namepython-codon-tables JSON
Version 0.1.12 PyPI version JSON
download
home_pagehttps://github.com/Edinburgh-Genome-Foundry/codon-usage-tables
SummaryCodon Usage Tables for Python, from kazusa.or.jp
upload_time2022-05-05 16:29:18
maintainer
docs_urlNone
authorZulko
requires_python
licensePublic Domain
keywords dna codon usage
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            Python Codon Tables
===================

.. image:: https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables/actions/workflows/build.yml/badge.svg
    :target: https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables/actions/workflows/build.yml
    :alt: GitHub CI build status

Provides codon usage tables as dictionnaries, for Python 3+.

Tables for the following organisms are provided with the library (any other
table can be downloaded using a TaxID):

- *B. subtilis*
- *C. elegans*
- *D. melanogaster*
- *E. coli*
- *G. gallus*
- *H. sapiens*
- *M. musculus*
- *M. musculus domesticus*
- *S. cerevisiae*

All the tables are from `kazusa.or.jp <http://www.kazusa.or.jp/codon/readme_codon.html>`_
and here is the original paper to cite:

.. code::

    Codon usage tabulated from the international DNA sequence databases:
    status for the year 2000.
    Nakamura, Y., Gojobori, T. and Ikemura, T. (2000) Nucl. Acids Res. 28, 292.

Usage
-----

.. code:: python

    import python_codon_tables as pct

    # PRINT THE LIST OF NAMES OF ALL AVAILABLE TABLES
    print ('Available tables:', pct.available_codon_tables_names)

    # LOAD ONE TABLE BY NAME
    table = pct.get_codons_table("b_subtilis_1423")
    print (table['T']['ACA'])  # returns 0.4
    print (table['*']['TAA'])  # returns 0.61

    # LOAD ONE TABLE BY TAXID (it will get it from the internet if it is not
    # in the builtin tables)
    table = pct.get_codons_table(1423)
    print (table['T']['ACA'])  # returns 0.4
    print (table['*']['TAA'])  # returns 0.61

    # LOAD ALL BUIL-IN TABLES AT ONCE
    codons_tables = pct.get_all_available_codons_tables()
    print (codons_tables['c_elegans_6239']['L']['CTA'])  # returns 0.09

- Notice that by default the tables use nucleotide T instead of U. Using ``get_codons_table('e_coli', replace_U_by_T=False)`` will leave Us as Us.

- In ``get_codons_table`` you can also provide a "shorthand" notation ``b_subtilis``, which will be automatically extended to ``b_subtilis_1423`` as it appears so in the built-in table (use this feature at your own risks!)

Contribute
----------

This project was started at the Edinburgh Genome Foundry by Zulko and is released on `Github <https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables>`_ under a Public Domain licence (and no warranty whatsoever, please cross-check the codon usage with other sources if you are not sure). Feel free to add other tables if you think of more commonly used species.

Installation
------------

via pip:

.. code:: bash

    pip install python_codon_tables

Manual:

.. code:: bash

    (sudo) python setup.py install

More biology software
-----------------------

.. image:: https://raw.githubusercontent.com/Edinburgh-Genome-Foundry/Edinburgh-Genome-Foundry.github.io/master/static/imgs/logos/egf-codon-horizontal.png
  :target: https://edinburgh-genome-foundry.github.io/

This library is part of the `EGF Codons <https://edinburgh-genome-foundry.github.io/>`_ synthetic biology software suite for DNA design, manufacturing and validation.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables",
    "name": "python-codon-tables",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "DNA codon usage",
    "author": "Zulko",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/37/93/5f40dceaf6e0104c03b54fb89fa7f7dcafdff6159721f1c2f812fff57784/python_codon_tables-0.1.12.tar.gz",
    "platform": null,
    "description": "Python Codon Tables\n===================\n\n.. image:: https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables/actions/workflows/build.yml/badge.svg\n    :target: https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables/actions/workflows/build.yml\n    :alt: GitHub CI build status\n\nProvides codon usage tables as dictionnaries, for Python 3+.\n\nTables for the following organisms are provided with the library (any other\ntable can be downloaded using a TaxID):\n\n- *B. subtilis*\n- *C. elegans*\n- *D. melanogaster*\n- *E. coli*\n- *G. gallus*\n- *H. sapiens*\n- *M. musculus*\n- *M. musculus domesticus*\n- *S. cerevisiae*\n\nAll the tables are from `kazusa.or.jp <http://www.kazusa.or.jp/codon/readme_codon.html>`_\nand here is the original paper to cite:\n\n.. code::\n\n    Codon usage tabulated from the international DNA sequence databases:\n    status for the year 2000.\n    Nakamura, Y., Gojobori, T. and Ikemura, T. (2000) Nucl. Acids Res. 28, 292.\n\nUsage\n-----\n\n.. code:: python\n\n    import python_codon_tables as pct\n\n    # PRINT THE LIST OF NAMES OF ALL AVAILABLE TABLES\n    print ('Available tables:', pct.available_codon_tables_names)\n\n    # LOAD ONE TABLE BY NAME\n    table = pct.get_codons_table(\"b_subtilis_1423\")\n    print (table['T']['ACA'])  # returns 0.4\n    print (table['*']['TAA'])  # returns 0.61\n\n    # LOAD ONE TABLE BY TAXID (it will get it from the internet if it is not\n    # in the builtin tables)\n    table = pct.get_codons_table(1423)\n    print (table['T']['ACA'])  # returns 0.4\n    print (table['*']['TAA'])  # returns 0.61\n\n    # LOAD ALL BUIL-IN TABLES AT ONCE\n    codons_tables = pct.get_all_available_codons_tables()\n    print (codons_tables['c_elegans_6239']['L']['CTA'])  # returns 0.09\n\n- Notice that by default the tables use nucleotide T instead of U. Using ``get_codons_table('e_coli', replace_U_by_T=False)`` will leave Us as Us.\n\n- In ``get_codons_table`` you can also provide a \"shorthand\" notation ``b_subtilis``, which will be automatically extended to ``b_subtilis_1423`` as it appears so in the built-in table (use this feature at your own risks!)\n\nContribute\n----------\n\nThis project was started at the Edinburgh Genome Foundry by Zulko and is released on `Github <https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables>`_ under a Public Domain licence (and no warranty whatsoever, please cross-check the codon usage with other sources if you are not sure). Feel free to add other tables if you think of more commonly used species.\n\nInstallation\n------------\n\nvia pip:\n\n.. code:: bash\n\n    pip install python_codon_tables\n\nManual:\n\n.. code:: bash\n\n    (sudo) python setup.py install\n\nMore biology software\n-----------------------\n\n.. image:: https://raw.githubusercontent.com/Edinburgh-Genome-Foundry/Edinburgh-Genome-Foundry.github.io/master/static/imgs/logos/egf-codon-horizontal.png\n  :target: https://edinburgh-genome-foundry.github.io/\n\nThis library is part of the `EGF Codons <https://edinburgh-genome-foundry.github.io/>`_ synthetic biology software suite for DNA design, manufacturing and validation.\n\n\n",
    "bugtrack_url": null,
    "license": "Public Domain",
    "summary": "Codon Usage Tables for Python, from kazusa.or.jp",
    "version": "0.1.12",
    "project_urls": {
        "Homepage": "https://github.com/Edinburgh-Genome-Foundry/codon-usage-tables"
    },
    "split_keywords": [
        "dna",
        "codon",
        "usage"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2d8fe48d9b9ce1da48bc14c7258975d76aa79ffb49b7ca287fdd22293d30674d",
                "md5": "13cd27d36b34077d3e26241b33cc579e",
                "sha256": "42a5dd87c04273680a323b92ef26d8e4d894932eeef417bc7f2af2869b7b49bb"
            },
            "downloads": -1,
            "filename": "python_codon_tables-0.1.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "13cd27d36b34077d3e26241b33cc579e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 18473,
            "upload_time": "2022-05-05T16:29:15",
            "upload_time_iso_8601": "2022-05-05T16:29:15.860019Z",
            "url": "https://files.pythonhosted.org/packages/2d/8f/e48d9b9ce1da48bc14c7258975d76aa79ffb49b7ca287fdd22293d30674d/python_codon_tables-0.1.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37935f40dceaf6e0104c03b54fb89fa7f7dcafdff6159721f1c2f812fff57784",
                "md5": "92164ef163244d411d31ba6ce65473a7",
                "sha256": "a733e8479e6753c39b3efd62204e76aa9a83e7119d60b9b5b86de7083e88e3a6"
            },
            "downloads": -1,
            "filename": "python_codon_tables-0.1.12.tar.gz",
            "has_sig": false,
            "md5_digest": "92164ef163244d411d31ba6ce65473a7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14920,
            "upload_time": "2022-05-05T16:29:18",
            "upload_time_iso_8601": "2022-05-05T16:29:18.094045Z",
            "url": "https://files.pythonhosted.org/packages/37/93/5f40dceaf6e0104c03b54fb89fa7f7dcafdff6159721f1c2f812fff57784/python_codon_tables-0.1.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-05-05 16:29:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Edinburgh-Genome-Foundry",
    "github_project": "codon-usage-tables",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "lcname": "python-codon-tables"
}
        
Elapsed time: 0.45436s