Skip to content

Commit

Permalink
Add pepschema directive in the documentation (#1092)
Browse files Browse the repository at this point in the history
* Add `pepschema` directive docs

add links to eido and how to write a PEP schema guide

* add pep validation note
  • Loading branch information
stolarczyk committed Jul 16, 2021
1 parent 3f364bb commit f052f60
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/snakefiles/configuration.rst
Expand Up @@ -197,6 +197,12 @@ For those, one should always complement the pepfile with an ordinary :ref:`confi
The rationale is that PEPs should be portable between different data analysis workflows (that could be applied to the same data) and even between workflow management systems.
In other words, a PEP should describe everything needed about the data, while a workflow and its configuration should describe everything needed about the analysis that is applied to it.

^^^^^^^^^^^^^^^
Validating PEPs
^^^^^^^^^^^^^^^

Using the ``pepschema`` directive leads to an automatic parsing of the provided schema *and* PEP validation with the PEP validation tool -- `eido <http://eido.databio.org>`_. Eido schemas extend `JSON Schema <https://json-schema.org>`_ vocabulary to accommodate the powerful PEP features. Follow the `How to write a PEP schema <http://eido.databio.org/en/latest/writing-a-schema>`_ guide to learn more.

.. _snakefiles-cluster_configuration:

----------------------------------
Expand Down

0 comments on commit f052f60

Please sign in to comment.