Skip to main content

Python and R based tool for assessing the quality of alignments

Project description

# AlignQC

See wiki for the most up-to-date manual.

[https://github.com/jason-weirather/AlignQC/wiki](https://github.com/jason-weirather/AlignQC/wiki)

Generate a report on sequencing alignments to understand read alignments vs read sizes, error patterns in reads, annotations and rarefractions.

Share your reports with anyone who has an internet browser.

Ultimately this software should be suitable for assessing alignments of from a variety of sequencing platforms and a variety of sequence types. The focus for the first version of this software is on the transcriptome analysis of third generation sequencing data outputs.

##### Report Generation Requirements - Linux - R - python 2.7+

##### Report Viewing Requirements - Mozilla Firefox or Google Chrome Browser

##### Installation (optional)

You can add the AlignQC/bin directory to your path if you want to call alignqc directly from the command line.

If you require a path for python 2.7+ other than /usr/bin/python, you can modify AlignQC/bin/alignqc to reflect this.

If you prefer to invoke AlignQC directly from python you can, i.e., python AlignQC/bin/alignqc

By default Rscript should be installed in your path, if it is not, you can specify a location during the analysis command with the –rscript_path option.

##### Fast start The following command should be sufficient for assessing a long read alignment.

alignqc analysis long_reads.bam -r ref_genome.fa -a ref_transcriptome.gpd -o long_reads.alignqc.xhtml

If you don’t readily have your reference genome or reference annotation available you can try the following.

alignqc analysis long_reads.bam –no_reference –no_annotation -o long_reads.alignqc.xhtml

## AlignQC programs Currently AlignQC only offers the analysis program.

## Analysis alignqc analysis

The analysis command is the most basic command for assessing an alignment. It provides reports and plots in xhtml format.

### Inputs A complete list of optional commands for each sub command is available with the -h option.

alignqc analysis -h

Will report all analysis required and optional inputs.

#### 1. BAM format alignment file The preferred format for transcriptome analysis is GMAP output (the ‘samse’) format. Default output, or an output that can produce multiple alignment paths for a read is recommended if you want the ability to assess chimeric reads.

You can convert the SAM output of GMAP into BAM format using Samtools. http://www.htslib.org/

Any properly formated BAM file should work however this software has only been tested with GMAP and hisat outputs at the moment. http://samtools.github.io/hts-specs/SAMv1.pdf

Please note that analyzing very large hiseq datasets has not been tested and memory requirements have not been optimized for this type of run. If you want to check error patterns of HISEQ downsampling the data is advised.

#### (optional) 2. Genome fasta file The reference genome these sequences were aligned to, in fasta format, can allows you to assess the error rates and error patterns in the alignments.

If you choose not to use a reference genome you must explicitly specify –no_reference

#### (optional) 3. GenePred format annotation file Providing an annotation file provides context such as known transcripts, and exons, introns, and intergenic regions to help describe the data. It is also necessary for rarefraction curves.

If you choose not to use a reference annotation you must explicitly specify –no_annotation

The genePred format is described here. http://www.healthcare.uiowa.edu/labs/au/IDP/IDP_gpd_format.asp

And it is also described here as “Gene Predictions and RefSeq Genes with Gene Names” genePred format described by UCSC. https://genome.ucsc.edu/FAQ/FAQformat.html#format9

  • geneName
  • name
  • chrom
  • strand
  • txStart
  • txEnd
  • cdsStart
  • cdsEnd
  • exoncount
  • exonStarts
  • exonEnds

### Outputs At least one output format must be specified.

To view the output xhtml Mozilla Firefox or Google Chrome browser is recommend.

Since the recommended output type contains large URI data embedded in the xhtml page, Internet Explorer will likely not be compatible. The memory requirements of the regular output may strain some systems.

If you only want to share the visual results with others we recommend the –portable_output option because this version contains only the main text and png files.

If accessing the embedded data in the xhtml is a problem, you can output the data in a folder format –output_folder, which can provide you more convenient access.

#### (option 1) Standard xhtml output -o or –output

The recommended output of this software is a single xhtml file that contains all the relevant files from the analysis embeded as base64 encoded URI data.

This means you can click any of the links in the document and the browser will download the data of interest (i.e. PDF format versions of a figure) from within the document.

Bed tracks compatible with the UCSC genome browser are also provided.

#### (option 2) Portable xhtml output –portable_output

This output is recommended if you want to email these results or share them over a bandwidth limited connection. This format only has the png images and webpage text. Links are disabled.

#### (option 3) Output folder –output_folder

Store an output folder that contains all the data and figures. An xhtml file is still available in this folder.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
AlignQC-2.0.5-py2-none-any.whl (85.9 kB) Copy SHA256 hash SHA256 Wheel py2
AlignQC-2.0.5.tar.gz (71.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page