{"id":13637856,"url":"https://github.com/broadinstitute/oncotator","last_synced_at":"2025-04-19T17:32:15.137Z","repository":{"id":8557568,"uuid":"10182465","full_name":"broadinstitute/oncotator","owner":"broadinstitute","description":null,"archived":true,"fork":false,"pushed_at":"2022-06-21T21:06:57.000Z","size":12525,"stargazers_count":67,"open_issues_count":119,"forks_count":32,"subscribers_count":38,"default_branch":"develop","last_synced_at":"2024-08-03T01:11:54.633Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/broadinstitute.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-05-20T21:35:48.000Z","updated_at":"2024-04-10T14:11:37.000Z","dependencies_parsed_at":"2022-09-05T10:41:46.410Z","dependency_job_id":null,"html_url":"https://github.com/broadinstitute/oncotator","commit_stats":null,"previous_names":[],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadinstitute%2Foncotator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadinstitute%2Foncotator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadinstitute%2Foncotator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadinstitute%2Foncotator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/broadinstitute","download_url":"https://codeload.github.com/broadinstitute/oncotator/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223804970,"owners_count":17205832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T01:00:35.651Z","updated_at":"2024-11-09T08:30:24.899Z","avatar_url":"https://github.com/broadinstitute.png","language":"Python","readme":"  .. image:: https://travis-ci.org/broadinstitute/oncotator.svg?branch=develop\n    :target: https://travis-ci.org/broadinstitute/oncotator\n  \n  .. image:: https://coveralls.io/repos/broadinstitute/oncotator/badge.png?branch=issue_211_travis\n    :target: https://coveralls.io/r/broadinstitute/oncotator?branch=issue_211_travis\n\n======================\nOncotator Is No Longer Supported or Maintained\n======================\n\nFuncotator is a new Functional Annotation tool (the spiritual successor to Oncotator).  It is: \n  * Better: many bugs have been fixed and edge cases have been improved.\n  * Faster: annotate more variants in less time\n  * Easier to use and deploy: a single jar with no tricky installation or dependencies, and a tool for fetching the datasources\n\nFuncotator is available as part of the GATK toolkit and works out of the box with both Mutect2 and HaplotypeCaller for somatic and germline annotation, respectively. \nIt also has a Featured Workspace on Terra.\n\nA Funcotator tutorial, as well as a full comparison of Funcotator and Oncotator and other helpful information can be found on the GATK website here:\nhttps://gatk.broadinstitute.org/hc/en-us/articles/360035889931-Funcotator-Information-and-Tutorial\n\nThe github repository for GATK and Funcotator can be found here:\nhttps://github.com/broadinstitute/gatk\n\n\n\n-----------------------------------\n\n\n\n======================\nOncotator\n======================\n\nLicense\n-------\n\nOncotator is free for non-profit users.  Please see the LICENSE file here for more information.\n\nPackage Overview\n----------------\n\nThe name of the directory, oncotator, is also the name of the **distribution**.\nThis distribution contains the oncotator package.\n\nFor more information:\nhttp://www.broadinstitute.org/cancer/cga/oncotator\n\nThis distribution is the standalone version of Oncotator.  If you wish to use the web interface:\nhttp://www.broadinstitute.org/oncotator\n\nPlease note that the web interface uses an older version of Oncotator and older datasources.\n\nAll documentation can be found in the Oncotator forums: http://gatkforums.broadinstitute.org/categories/oncotator\n\nInstallation\n------------\n\nCurrently, Windows is unsupported, though this is due to a dependency, pysam, being unsupported in Windows.\n\nIMPORTANT:  You will need root access to your python interpreter or a python virtual environment.  More information about virtual environments can be found on the following site:\nhttps://pypi.python.org/pypi/virtualenv\n\nAs a reminder, virtualenv.py can be run as a standalone script, thereby bypassing superuser requirements.  Please see the above link for more details.\n\nBefore installing, we recommend installing pyvcf and numpy manually, before attempting the Oncotator install.  You may need to prepend each of the following commands with sudo::\n\n    $ pip install numpy\n    $ pip install pyvcf\n\nThis distribution is installable through the standard ``setup.py`` method.  Note that Distribute will be installed as part of the setup process if it isn't already::\n\n    $ python setup.py install\n\nBecause the setup.py specifies an entry point as a console script, ``oncotator``  and ``initializeDatasource`` will be installed into your Python's ``bin/`` directory\n\n\nUnit Test Setup\n---------------\n\nNOTE: Unit tests require a minimum of 4GB to run.\n\nBefore running the unit tests for the first time, please perform the following steps:\n\n1) Execute the following three lines in the same directory as setup.py::\n\n    $ mkdir -p out\n    $ ln -s test/configs configs\n    $ ln -s test/testdata testdata\n\n2) Many unit tests rely on having the standard set of hg19 datasources, which are in a separate download.  To point the unit testing framework to your datasources, you must create a personal test config::\n\n    $ cp configs/personal-test.config.template configs/personal-test.config\n    In configs/personal-test.config, replace ```dbDir=MY_DB_DIR/``` with ```dbDir=``` the appropriate path to you oncotator datasource directory.\n\n\nRunning the Automated Unit Tests (with Virtual Env Creation)\n--------------------\nThe automated unit tests (``run_ci_tests.sh``) require 6 GB to run.\nThis can take a fair amount of time (~20 minutes), since a full install into a new virtual environment is performed.\n\nExecute the following line in the same directory as setup.py (provide the appropriate path to the db dir with your datasources)::\n\n    $ bash run_ci_tests.sh \u003cDB_DIR\u003e\n\n\nRunning the Automated Unit Tests (without Virtual Env Creation)\n--------------------\nYou can simply run the unit tests in the currently active python environment, which takes a lot less time (\u003c 6 minutes), but requires\nall dependencies to be installed.  However, you must follow the instructions for Unit Test Setup above (Steps 1 and 2), if\nnot already performed.  Then run (in the same directory as setup.py)::\n\n    $ nosetests --all-modules --exe -w test -v --processes=4 --process-timeout=480  --process-restartworker\n\n\nPlease note that there is a known bug with ``--processes`` and output to XML.  If you alter the above nosetests command to include junit xml (``--with-xunit``), remove the last three options (```--processes=4 --process-timeout=480  --process-restartworker```).  This will cause tests to only run on one core.\n\nCreating a Virtual Environment for Running Oncotator\n--------------------\nFollow these steps from the same directory as setup.py.  The first command will take several minutes::\n\n    bash scripts/create_oncotator_venv.sh \u003cvenv_location\u003e\n    source \u003cvenv_location\u003e/bin/activate\n    python setup.py install\n\nVersion Information\n-------------------\n\nOnce Oncotator is installed, run it with the -V flag to get version information::\n\n    $ Oncotator -V\n\n\nGit Process Starting with v1.0.0.0 (Developers)\n-----------------------------------------------\n\nFor an overview on the oncotator process for adding features, bugfixes, and general day-to-day branching, please see::\nhttp://nvie.com/posts/a-successful-git-branching-model/\n\n\nHelp\n-------------------\n\nPlease post questions, issues, and feature requests in the forum at http://gatkforums.broadinstitute.org/categories/oncotator\n","funding_links":[],"categories":["Genomics"],"sub_categories":["Mutations"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbroadinstitute%2Foncotator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbroadinstitute%2Foncotator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbroadinstitute%2Foncotator/lists"}