{"id":15018365,"url":"https://github.com/rennelab/hybkit","last_synced_at":"2025-10-23T18:31:11.137Z","repository":{"id":46800361,"uuid":"233707382","full_name":"RenneLab/hybkit","owner":"RenneLab","description":"Toolkit for analysis of \".hyb\" format nucleotide sequence data from chimeric RNA experiments.","archived":false,"fork":false,"pushed_at":"2024-08-07T11:27:27.000Z","size":360805,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-29T21:28:42.214Z","etag":null,"topics":["bioinformatics","bioinformatics-pipeline","bioinformatics-tool","clash","genomics","hyb","qclash","ribonomics"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RenneLab.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-13T22:32:20.000Z","updated_at":"2024-08-07T11:27:30.000Z","dependencies_parsed_at":"2022-08-22T23:31:05.932Z","dependency_job_id":"5bb6ad41-6a9e-45e2-8e5c-76d97ec9e239","html_url":"https://github.com/RenneLab/hybkit","commit_stats":{"total_commits":447,"total_committers":1,"mean_commits":447.0,"dds":0.0,"last_synced_commit":"b8db214d68d5037c6e87e3b5cb45dfa8de29e4a2"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenneLab%2Fhybkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenneLab%2Fhybkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenneLab%2Fhybkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenneLab%2Fhybkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RenneLab","download_url":"https://codeload.github.com/RenneLab/hybkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237869272,"owners_count":19379293,"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":["bioinformatics","bioinformatics-pipeline","bioinformatics-tool","clash","genomics","hyb","qclash","ribonomics"],"created_at":"2024-09-24T19:51:53.173Z","updated_at":"2025-10-23T18:31:01.714Z","avatar_url":"https://github.com/RenneLab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"******\nhybkit\n******\n.. image:: https://img.shields.io/github/v/release/RenneLab/hybkit?include_prereleases\u0026logo=github\n   :target: https://github.com/RenneLab/hybkit/releases\n   :alt: GitHub release (latest by date including pre-releases)\n.. image:: https://img.shields.io/pypi/v/hybkit?logo=pypi\u0026logoColor=white\n   :target: https://pypi.org/project/hybkit/\n   :alt: PyPI Package Version\n.. image:: https://img.shields.io/conda/vn/bioconda/hybkit?logo=anaconda\n   :target: http://bioconda.github.io/recipes/hybkit/README.html\n   :alt: Bioconda Release\n.. image:: https://img.shields.io/conda/dn/bioconda/hybkit?logo=Anaconda\n   :target: http://bioconda.github.io/recipes/hybkit/README.html\n   :alt: Hybkit Downloads on Bioconda\n.. image:: https://img.shields.io/conda/vn/bioconda/hybkit?color=lightgrey\u0026label=Image%20%28quay.io%29\u0026logo=docker\n   :target: https://quay.io/repository/biocontainers/hybkit?tab=tags\n   :alt: Docker Image Version\n.. image:: https://img.shields.io/circleci/build/github/RenneLab/hybkit?label=CircleCI\u0026logo=circleci\n   :target: https://app.circleci.com/pipelines/github/RenneLab/hybkit\n   :alt: Circle-CI Build Status\n.. image:: https://img.shields.io/readthedocs/hybkit?logo=read-the-docs\n   :target: https://hybkit.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation Status\n.. image:: https://img.shields.io/coveralls/github/RenneLab/hybkit?logo=coveralls\n   :target: https://coveralls.io/github/RenneLab/hybkit\n   :alt: Coveralls Coverage\n.. image:: https://img.shields.io/pypi/pyversions/hybkit?logo=python\u0026logoColor=white\n   :target: https://pypi.org/project/hybkit/\n   :alt: PyPI - Python Version\n.. image:: https://img.shields.io/badge/DOI-10.1093%2Fbioinformatics%2Fbtad721-0887BA?style=flat\u0026logo=DOI\u0026logoColor=white\n   :target: https://doi.org/10.1093/bioinformatics/btad721\n   :alt: Manuscript DOI, Journal Bioinformatics\n.. image:: https://img.shields.io/badge/License-GPLv3+-blue?logo=GNU\n   :target: https://www.gnu.org/licenses/gpl-3.0.en.html\n   :alt: GNU GPLv3+ License\n\n| Welcome to *hybkit*, a toolkit for analysis of hyb-format chimeric\n  (hybrid) RNA sequence data defined with the Hyb software package by |Travis2014|_.\n  This genomic data-type is generated from RNA proximity-ligation and ribonomics\n  techniques such as Crosslinking, Ligation, and\n  Sequencing of Hybrids (CLASH; |Helwak2013|_) and quick CLASH (qCLASH; |Gay2018|_).\n| This software is available via Github, at http://www.github.com/RenneLab/hybkit .\n| Full project documentation is available at |docs_link|_.\n\nProject components:\n    #. hybkit toolkit of command-line utilities for manipulating,\n       analyzing, and plotting hyb-format data.\n    #. The hybkit python API, an extendable documented codebase\n       for creation of custom analyses of hyb-format data.\n    #. Integrated analysis of predicted secondary structure (fold) information for\n       the API and command-line utilities.\n    #. Example analyses for publicly available qCLASH hybrid\n       sequence data implemented in each of the command-line scripts and hybkit Python API.\n\nHybkit Toolkit:\n    The hybkit toolkit includes several command-line utilities\n    for manipulation of hyb-format data:\n\n        =================================== ===========================================================\n        Utility                             Description\n        =================================== ===========================================================\n        hyb_check                           Parse hyb (and fold) files and check for errors\n        hyb_eval                            Evaluate hyb (and fold) records to identify / assign\n                                            segment types and miRNAs using custom criteria\n        hyb_filter                          Filter hyb (and fold) records to a specific\n                                            custom subset\n        hyb_analyze                         Perform an energy, type, miRNA, target, or fold analysis\n                                            on hyb (and fold) files and plot results\n        =================================== ===========================================================\n\n    These scripts are used on the command line with hyb (and associated \"vienna\" or \"CT\") files.\n    For example, to filter a\n    hyb and corresponding vienna file to contain only hybrids with\n    a sequence identifier containing the string \"kshv\":\n\n    Example:\n\n        ::\n\n            $ hyb_filter -i my_hyb_file.hyb -f my_hyb_file.vienna --filter any_seg_contains kshv\n\n    Further detail on the usage of each script is provided in\n    the |hybkit Toolkit| section of |docs_link|_.\n\n\nHybkit API:\n    Hybkit provides a Python3 module with a documented API for interacting with\n    records in hyb files and associated vienna or CT files.\n    This capability was inspired by the `BioPython Project \u003chttps://biopython.org/\u003e`_.\n    The primary utility is provided by a class for hyb records (HybRecord), a class\n    for fold records (FoldRecord), and file-iterator classes\n    (HybFile, ViennaFile, CTFile, HybFoldIter).\n    Record attributes can be analyzed, set, and evaluated using included class methods.\n\n    For example, a workflow to print the identifiers of only sequences within a \".hyb\" file\n    that contain a miRNA can be performed as such:\n\n    .. code-block:: Python\n\n        #!/usr/bin/env python3\n        import hybkit\n        in_file = '/path/to/my_hyb_file.hyb'\n\n        # Open a hyb file as a HybFile Object:\n        with hybkit.HybFile.open(in_file, 'r') as hyb_file:\n\n            # Return each line in a hyb file as a HybRecord object\n            for hyb_record in hyb_file:\n\n                # Analyze each record to assign segment types\n                hyb_record.eval_types()\n\n                # If the record contains a long noncoding RNA type, print the record identifier.\n                if hyb_record.has_prop('any_seg_type_contains', 'lncRNA')\n                    print(hyb_record.id)\n\n    Further documentation on the hybkit API can be found in the\n    |hybkit API| section of |docs_link|_.\n\nExample Analyses:\n    Hybkit provides several example analyses for hyb data using the\n    utilities provided in the toolkit. These include:\n\n        ============================= ===========================================================\n        Analysis                      Description\n        ============================= ===========================================================\n        Type/miRNA Analysis           Quantify sequence types and miRNA types in a hyb file\n        Target Analysis               Analyze targets of a set of miRNAs from a single\n                                      experimental replicate\n        Grouped Target Analysis       Analyze and plot targets of a set of miRNAs from\n                                      pooled experimental replicates\n        Fold Analysis                 Analyze and plot predicted miRNA folding patterns in\n                                      miRNA-containing hybrids\n        ============================= ===========================================================\n\n    These analyses provide analysis results in both tabular and graph form.\n    As an illustration, the example summary analysis includes the return of\n    the contained hybrid sequence types as both a csv table and as a pie chart:\n\n        `CSV Output \u003chttps://raw.githubusercontent.com/RenneLab/hybkit/master/example_01_type_mirna_analysis/example_output/combined_analysis_type_hybrid_types.csv\u003e`_\n\n        |example_01_image|\n\n    Further detail on each provided analysis can be found in\n    the |Example Analyses| section of |docs_link|_.\n\nInstallation:\n    Dependencies:\n        * Python3.8+\n        * `matplotlib \u003chttps://matplotlib.org/\u003e`_ \u003e= 3.7.1 (|Hunter2007|_)\n        * `BioPython \u003chttps://biopython.org/\u003e`_ \u003e= 1.79 (|Cock2009|_)\n        * `typing_extensions \u003chttps://pypi.org/project/typing-extensions/\u003e` \u003e= 4.8.0\n\n    Via PyPI / Python PIP:\n        |PipVersion|\n\n        The recommended installation method is via hybkit's\n        `PyPI Package Index \u003chttps://pypi.org/project/hybkit/\u003e`_ using\n        `python3 pip \u003chttps://pip.pypa.io/en/stable/\u003e`_, which will\n        automatically handle version control and dependency installation:\n\n        .. code-block:: bash\n\n            $ python3 -m pip install hybkit\n\n    Via Conda:\n        |CondaVersion| |InstallBioconda|\n\n        For users of conda, the hybkit package and dependencies are hosted on the\n        the `Bioconda \u003chttps://bioconda.github.io/\u003e`_ channel, and can be installed\n        using conda:\n\n        .. code-block:: bash\n\n            $ conda install -c bioconda hybkit\n\n    Via Docker/Singularity:\n        |DockerVersion|\n\n        The hybkit package is also available as a `Docker \u003chttps://www.docker.com/\u003e`_\n        image and `Singularity \u003chttps://sylabs.io/singularity/\u003e`_ container, hosted\n        via the `BioContainers \u003chttps://biocontainers.pro/\u003e`_ project on\n        `quay.io \u003chttps://quay.io/repository/biocontainers/hybkit?tab=tags\u003e`_.\n        To pull the image via docker:\n\n        .. code-block:: bash\n\n            $ docker pull quay.io/biocontainers/hybkit:0.3.3--pyhdfd78af_0\n\n        To pull the image via singularity:\n\n        .. code-block:: bash\n\n            $ singularity pull docker://quay.io/biocontainers/hybkit:0.3.3--pyhdfd78af_0\n\n    Manually Download and Install:\n        |GithubVersion|\n\n        Use git to clone the project's Github repository:\n\n        .. code-block:: bash\n\n            $ git clone git://github.com/RenneLab/hybkit\n\n        *OR* download the zipped package:\n\n        .. code-block:: bash\n\n            $ curl -OL https://github.com/RenneLab/hybkit/archive/master.zip\n            $ unzip master.zip\n\n        Then install using python setuptools:\n\n        .. code-block:: bash\n\n            $ python setup.py install\n\n    Further documentation on hybkit usage can be found in |docs_link|_.\n\nSetup Testing:\n    Hybkit provides a suite of unit tests to maintain stability of the API and script\n    functionalities. To run the API test suite, install pytest and run the tests from the\n    root directory of the hybkit package:\n\n    .. code-block:: bash\n\n        $ pip install pytest\n        $ pytest\n\n    Command-line scripts can be tested by running the auto_test.sh script in\n    the auto_tests directory:\n\n    .. code-block:: bash\n\n        $ ./auto_tests/auto_test.sh\n\n\nCopyright:\n    | hybkit is a free, sharable, open-source project.\n    | All source code and executable scripts contained within this package are considered\n        part of the \"hybkit\" project and are distributed without any warranty or implied warranty\n        under the GNU General Public License v3.0 or any later version, described in the \"LICENSE\"\n        file.\n\n.. |Helwak2013| replace:: *Helwak et al. (Cell 2013)*\n.. _Helwak2013: https://doi.org/10.1016/j.cell.2013.03.043\n.. |Travis2014| replace:: *Travis et al. (Methods 2014)*\n.. _Travis2014: https://doi.org/10.1016/j.ymeth.2013.10.015\n.. |Gay2018| replace:: *Gay et al. (J. Virol. 2018)*\n.. _Gay2018: https://doi.org/10.1128/JVI.02138-17\n.. |Hunter2007| replace:: *Hunter JD. (Computing in Science \u0026 Engineering 2007)*\n.. _Hunter2007: https://doi.org/10.1109/MCSE.2007.55\n.. |Cock2009| replace:: *Cock et al. (Bioinformatics 2009)*\n.. _Cock2009: https://doi.org/10.1093/bioinformatics/btp163\n.. |PipVersion| image:: https://img.shields.io/pypi/v/hybkit?logo=pypi\u0026logoColor=white\n   :target: https://pypi.org/project/hybkit/\n   :alt: PyPI Package Version\n.. |InstallBioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat\u0026logo=anaconda\n   :target: http://bioconda.github.io/recipes/hybkit/README.html\n   :alt: Install with Bioconda\n.. |CondaVersion| image:: https://img.shields.io/conda/vn/bioconda/hybkit?logo=anaconda\n   :target: http://bioconda.github.io/recipes/hybkit/README.html\n   :alt: Bioconda Release\n.. |DockerVersion| image:: https://img.shields.io/conda/vn/bioconda/hybkit?color=lightgrey\u0026label=Image%20%28quay.io%29\u0026logo=docker\n   :target: https://quay.io/repository/biocontainers/hybkit?tab=tags\n   :alt: Docker Image Version\n.. |GithubVersion| image:: https://img.shields.io/github/v/release/RenneLab/hybkit?include_prereleases\u0026logo=github\n   :target: https://github.com/RenneLab/hybkit/releases\n   :alt: GitHub release (latest by date including pre-releases)\n\n.. Github Only\n.. |hybkit Toolkit| replace:: *hybkit Toolkit*\n.. |Example Analyses| replace:: *Example Analyses*\n.. |hybkit API| replace:: *hybkit API*\n.. |docs_link| replace:: hybkit's ReadTheDocs\n.. _docs_link: https://hybkit.readthedocs.io#\n.. |example_01_image| image:: https://raw.githubusercontent.com/RenneLab/hybkit/master/example_01_type_mirna_analysis/example_output/combined_analysis_types_mirna_hybrids.png\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frennelab%2Fhybkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frennelab%2Fhybkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frennelab%2Fhybkit/lists"}