:orphan: .. only available via index, not via toctree :nosearch: .. title:: Package Recipe 'biopax-validator' .. highlight: bash biopax-validator ================ .. conda:recipe:: biopax-validator :replaces_section_title: :noindex: Validates BioPAX data against the specification and best practice rules :homepage: https://biopax.github.io/validator/ :developer docs: https://github.com/BioPAX/validator :license: MIT / MIT :recipe: /`biopax-validator `_/`meta.yaml `_ :links: doi: :doi:`10.1093/bioinformatics/btt452` The BioPAX Validator checks BioPAX Level 3 data for syntactic errors and for violations of BioPAX best practice rules\, and reports the result as XML\, HTML or BioPAX. It can run fully offline\, loading the required OBO ontologies locally\, or delegate validation to the remote BioPAX Validator service. .. conda:package:: biopax-validator |downloads_biopax-validator| |docker_biopax-validator| :versions: ``6.0.0-0`` :depends on openjdk: ``>=17`` :additional platforms: Installation ------------ You need a conda-compatible package manager (currently either `pixi `__, `conda `__, or `micromamba `__) 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 biopax-validator to add into an existing workspace instead, run:: pixi add biopax-validator 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 biopax-validator Alternatively, to install into a new environment, run:: conda create -n envname biopax-validator 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/biopax-validator: (see `biopax-validator/tags`_ for valid values for ````). 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_biopax-validator| image:: https://img.shields.io/conda/dn/bioconda/biopax-validator.svg?style=flat :target: https://anaconda.org/bioconda/biopax-validator :alt: (downloads) .. |docker_biopax-validator| image:: https://quay.io/repository/biocontainers/biopax-validator/status :target: https://quay.io/repository/biocontainers/biopax-validator .. _`biopax-validator/tags`: https://quay.io/repository/biocontainers/biopax-validator?tab=tags .. raw:: html .. rubric:: Download stats .. raw:: html
.. Create all the necessary plots for each package by loading all the correct specs and data. Important points on the place and implementation of this script block: 1. It is here, and not in a separate HTML file, as it needs to have the `package.name` rendered in for each package. 2. All packages are handled in one `window.onload` function, as multiple instances of this throughout a (rendered) HTML just overwrite each other. Notes ----- Two wrapper scripts are installed on \$PATH. \"biopax\-validator\" validates offline and loads the required ontologies locally. \"biopax\-validator\-client\" sends the data to the remote BioPAX Validator service. JVM options are passed through the JAVA\_OPTS environment variable\, e.g. JAVA\_OPTS\=\"\-Xmx4g\" biopax\-validator input.owl \-\-output\=report.html Upstream recommends at least 2 GB of heap. Startup takes about a minute while the ontologies are loaded. Example input files are installed in \$CONDA\_PREFIX\/share\/biopax\-validator\-\\/sampleData. 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/biopax-validator/README.html) .. |install-with-bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat :target: http://bioconda.github.io/recipes/biopax-validator/README.html