:orphan:  .. only available via index, not via toctree

.. title:: Package Recipe 'gpatch'
.. highlight: bash

gpatch
======

.. conda:recipe:: gpatch
   :replaces_section_title:
   :noindex:

   Starting with alignments of contigs to a reference genome\, produce a chromosome\-scale pseudoassembly by patching gaps between mapped contigs with sequences from the reference. Download the github repository for helper scripts to automate GPatch workflows\, identify and correct misjoins in the contig assembly\, produce dot\-plots of patched pseudoassemblies to a reference assembly\, and generate chrom.sizes and liftover chains for patched pseudoassemblies.\"

   :homepage: https://github.com/adadiehl/GPatch.git
   :license: MIT / MIT
   :recipe: /`gpatch <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/gpatch>`_/`meta.yaml <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/gpatch/meta.yaml>`_

   


.. conda:package:: gpatch

   |downloads_gpatch| |docker_gpatch|

   :versions:
      
      

      ``0.4.0-0``,  ``0.3.8-0``,  ``0.3.6-0``,  ``0.3.5-0``,  ``0.3.4-0``

      

   
   :depends on biopython: ``>=1.84``
   :depends on pysam: ``>=0.22.1``
   :depends on python: ``>=3.7,<3.13``

   :additional platforms:
      

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

You need a conda-compatible package manager
(currently either `pixi <https://pixi.sh>`__, `conda <https://docs.conda.io/projects/conda>`__, or `micromamba <https://mamba.readthedocs.io>`__)
and the Bioconda channel already activated (see :ref:`bioconda_setup`).
Below, we show how to install with either pixi or conda (for micromamba and mamba, commands are essentially the same as with conda).

Pixi
""""

With pixi_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`),
to install globally, run::

    pixi global install gpatch

to add into an existing workspace instead, run::

    pixi add gpatch

In the latter case, make sure to first add bioconda and conda-forge to the channels considered by the workspace::

    pixi workspace channel add conda-forge
    pixi workspace channel add bioconda

Conda
"""""

With conda_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`), to install into an existing and activated environment, run::

    conda install gpatch

Alternatively, to install into a new environment, run::

    conda create -n envname gpatch

with ``envname`` being the name of the desired environment.

Container
"""""""""

Alternatively, every Bioconda package is available as a container image for usage with your preferred container runtime.
For e.g. docker, run::

    docker pull quay.io/biocontainers/gpatch:<tag>

(see `gpatch/tags`_ for valid values for ``<tag>``).

Integrated deployment
"""""""""""""""""""""

Finally, note that many scientific workflow management systems directly integrate both conda and container based software deployment.
Thus, workflow steps can be often directly annotated to use the package, leading to automatic deployment by the respective workflow management system, thereby improving reproducibility and transparency.
Check the documentation of your workflow management system to find out about the integration.

.. _conda: https://conda.io
.. _pixi: https://pixi.sh
.. |downloads_gpatch| image:: https://img.shields.io/conda/dn/bioconda/gpatch.svg?style=flat
   :target: https://anaconda.org/bioconda/gpatch
   :alt:   (downloads)
.. |docker_gpatch| image:: https://quay.io/repository/biocontainers/gpatch/status
   :target: https://quay.io/repository/biocontainers/gpatch
.. _`gpatch/tags`: https://quay.io/repository/biocontainers/gpatch?tab=tags


.. raw:: html

    <script>
        var package = "gpatch";
        var versions = ["0.4.0","0.3.8","0.3.6","0.3.5","0.3.4"];
    </script>






Download stats
-----------------

.. raw:: html
    :file: ../../templates/package_dashboard.html

Link to this page
-----------------

Render an |install-with-bioconda| badge with the following MarkDown::

   [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/gpatch/README.html)

.. |install-with-bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
   :target: http://bioconda.github.io/recipes/gpatch/README.html