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

.. title:: Package Recipe 'biopet-validatefastq'
.. highlight: bash

biopet-validatefastq
====================

.. conda:recipe:: biopet-validatefastq
   :replaces_section_title:
   :noindex:

   This tool validates a FASTQ file.

   :homepage: https://github.com/biopet/validatefastq
   :license: MIT
   :recipe: /`biopet-validatefastq <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/biopet-validatefastq>`_/`meta.yaml <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/biopet-validatefastq/meta.yaml>`_

   This tool validates a FASTQ file. When data is paired it can
   also validate a pair of FASTQ files.
   ValidateFastq will check if the FASTQ is in valid FASTQ format.
   This includes checking for duplicate reads and checking whether
   a pair of FASTQ files contains the same amount of reads and headers match.
   It also check whether the quality encodings are correct and outputs
   the most likely encoding format \(Sanger\, Solexa etc.\).

   For documentation and manuals visit our github.io page\: https\:\/\/biopet.github.io\/validatefastq


.. conda:package:: biopet-validatefastq

   |downloads_biopet-validatefastq| |docker_biopet-validatefastq|

   :versions:
      
      

      ``0.1.1-3``,  ``0.1.1-2``,  ``0.1.1-1``,  ``0.1.1-0``

      

   
   :depends on openjdk: ``>=8,<9``
   :depends on python: 

   :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 biopet-validatefastq

to add into an existing workspace instead, run::

    pixi add biopet-validatefastq

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 biopet-validatefastq

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

    conda create -n envname biopet-validatefastq

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/biopet-validatefastq:<tag>

(see `biopet-validatefastq/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_biopet-validatefastq| image:: https://img.shields.io/conda/dn/bioconda/biopet-validatefastq.svg?style=flat
   :target: https://anaconda.org/bioconda/biopet-validatefastq
   :alt:   (downloads)
.. |docker_biopet-validatefastq| image:: https://quay.io/repository/biocontainers/biopet-validatefastq/status
   :target: https://quay.io/repository/biocontainers/biopet-validatefastq
.. _`biopet-validatefastq/tags`: https://quay.io/repository/biocontainers/biopet-validatefastq?tab=tags


.. raw:: html

    <script>
        var package = "biopet-validatefastq";
        var versions = ["0.1.1","0.1.1","0.1.1","0.1.1"];
    </script>





Notes
-----
biopet\-validatefastq is a Java program that comes with a custom wrapper shell script. By default \'no default java option\' is set in the wrapper. The command that runs the program is \'biopet\-validatefastq\'. If you want to overwrite it you can specify memory options directly after your binaries. If you have \_JAVA\_OPTIONS set globally this will take precedence. For example run it with \'biopet\-validatefastq \-Xms512m \-Xmx1g\'. 


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/biopet-validatefastq/README.html)

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