Skip to main content

Python API for cortex.

Project description

py-cortex-api

Python API for cortex.

Install

pip3 install git+https://github.com/iqbal-lab-org/py-cortex-api

Requirements

R is required by cortex at runtime.

sudo apt install r-base-core

Usage

Inputs: * a reference genome in fasta[.gz] * one or more reads file in fasta/q[.gz]

Use a list to pass in reads files, even if there is only one file.

Output: A vcf with variants detected by cortex.

import cortex.calls as cortex
cortex.run("./reference.fasta",
             ["./reads.fastq"],
             "./output.vcf")

The third argument is where to place the output vcf.

Options

The following options can be passed to cortex.run:

  • sample_name: sample name to appear in output vcf (default: 'sample').
  • ploidy: 1 or 2, for haploid or diploid genotyping (default: 1)
  • mem_height: if cortex.calls fails warning of too low memory, use a higher value (default: 22).
  • tmp_directory: where to place intermediate output and log files (default: system-defined)
  • cleanup: whether to remove intermediate output and log files upon successful completion. (Default: True)

Licence

MIT

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 py-cortex-api, version 2.2.0
Filename, size File type Python version Upload date Hashes
Filename, size py-cortex-api-2.2.0.tar.gz (16.9 kB) File type Source Python version None Upload date Hashes View

Supported by

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