Skip to main content

Bioinformatics tools for Janis; the Pipeline creation helper

Project description

Janis - Bioinformatics Toolbox

Documentation Status Build Status PyPI version

This repository is the bioinformatics toolbox for Janis. It contains tools and data types directly related to the bioinformatics field.

You can see a full list of tools in the documentation.

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. Sometimes bioinformatics data types have associated files (like an indexed bam, or a fasta with various indexes); when you use these types, Janis will bundle your files together to be transported around.

Indexed Bam

Further information: Secondary / Accessory files

Janis is opinionated about the .bai index for a Bam. Specifically we use the pattern:

  • mysample.bam
  • mysample.bam.bai

If you tool expects, or creates a file in the other common format (.bam and .bai), you can use the secondaries_present_as attribute on a:

  • ToolInput to localise the index using a specific format (see: )
  • ToolOutput to prepare your input for .

Documentation

Documentation is generated on Janis. To generate new documentation you will need to:

  1. Commit your changes here,
  2. Update the submodule pointer on Janis,
  3. Checkout Janis (recursively),
  4. Run the regenerate script janis/docs/regeneratedocumentation.py,
  5. Commit these changes and the documentation will autobuild on ReadTheDocs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for janis-pipelines.bioinformatics, version 0.11.1
Filename, size File type Python version Upload date Hashes
Filename, size janis_pipelines.bioinformatics-0.11.1-py3-none-any.whl (5.7 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size janis-pipelines.bioinformatics-0.11.1.tar.gz (322.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page