Bioinformatics tools for Janis; the Pipeline creation helper
Project description
Bioinformatics Tools (Pipelines)
This repository contains tools and data types for Janis directly related to the bioinformatics field.
Refer to the documentation for a full list of tools.
Data types
The data types are a way of encapsulating information about the file (including secondary files), and it allows clarity when connecting inputs and steps together (as you know a BAM file should be connected to BAM input).
This documentation will be updated with a full (generated) list of data types, however for now here's an approximate list (nested means inherited):
Nested types
If a type is nested
Non-exhaustive of bioinformatics data types
Testing
I'm not sure how to unit tests these tools, they're mostly definitions and as long as the syntax is fine, it's hard to logically test them without functionally running them with test data.
As Janis contains unit tests, there should be sufficient coverage for the base of the command tools.
There are plans to build a module to functionally test these tools (with some test data), however that will probably be a little while away
Documentation
Documentation is generated on Janis. To generate new documentation you will need to:
- Commit your changes here,
- Update the submodule pointer on Janis,
- Checkout Janis (recursively),
- Run the regenerate script
janis/docs/regeneratedocumentation.py, - Commit these changes and the documentation will autobuild on ReadTheDocs.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for janis_pipelines.bioinformatics-0.0.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 15e5bb46d8c1fd88dc96e9cce4b943c65e171fb321446fe96276ab2c7fd2fcb4 |
|
| MD5 | b77ab9769aad357330bb2c8b0f98ffef |
|
| BLAKE2b-256 | f2c058cd2f9cd822e73a27cef6d5d2bd42cf7cc4070dbc29ef452c809e97a6f0 |
