.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "MAQVIEW 1" .TH MAQVIEW 1 "2018-10-21" "maqview-0.2.4" "Bioinformatics Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Maqview \- Maq alignment indexer and viewer .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBmaqindex\fR \fB\-i\fR|\fB\-v\fR|\fB\-b\fR [\fB\-c\fR \fIin.cns\fR] \fIin.map\fR [\fIchr\fR[:\fIstart\fR[\-\fIend\fR]] [...]] .PP \&\fBmaqview\fR [\fB\-c\fR \fIin.cns\fR] \fIin.map\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBMaqview\fR is a set of programs that achieves fast random access to the alignment file generated by `\fBmaq\fR map', and displays the alignment with a nice \s-1GUI\s0 (Graphical User Interface). It is highly efficient in speed, memory and disk usage. \fBMaqview\fR is based on OpenGL and is known to work on both Mac \s-1OS X\s0 and Linux. Porting to Windows is in principle easy. .SS "\fBmaqindex\fP" .IX Subsection "maqindex" \&\fBmaqindex\fR \fB\-i\fR|\fB\-v\fR|\fB\-b\fR [\fB\-c\fR \fIin.cns\fR] \fIin.map\fR [\fIchr\fR[:\fIstart\fR[\-\fIend\fR]] [...]] .IP "\fB\-i\fR" 9 .IX Item "-i" Index the alignment file .IP "\fB\-v\fR" 9 .IX Item "-v" Print the alignment in the specified region in the `maq mapview' format .IP "\fB\-b\fR" 9 .IX Item "-b" Dump the alignment in the specified region in the binary .map format .IP "\fB\-c\fR \fI\s-1FILE\s0\fR" 9 .IX Item "-c FILE" Index the Maq consensus file for viewing in maqview at the same time .PP Program \fBmaqindex\fR indexes a maq alignment file \fIin.map\fR or quickly retrieves all the reads in one or multiple regions. One of \fB\-i\fR, \fB\-v\fR and \fB\-b\fR must be used. For \fB\-v\fR or \fB\-b\fR, at least one region like `chrX', `chrX:1000' or `chrX:1,000\-2,000' must be specified. Multiple regions are allowed. .SS "\fBmaqview\fP" .IX Subsection "maqview" \&\fBmaqview\fR [\fB\-c\fR \fIin.cns\fR] \fIin.map\fR .IP "\fB\-c\fR \fI\s-1FILE\s0\fR" 9 .IX Item "-c FILE" The Maq consensus file .PP Program \fBmaqview\fR displays the read alignment in a graphical window. When \fIin.cns\fR is specified, the top sequence is the reference, followed by the Maq consensus sequence; otherwise, the majority-rule consensus will be calculated. .PP Maqview has two views: sequence view and box view. In the sequence view, read sequences will be printed on the screen. Darker bases indicate lower base qualities and red ones show the differences in comparison to the reference if \fIin.cns\fR is specified or to the majority-rule consensus if not. In the box view, different types of nucleotides are represented as colour boxes with green for A, cyan for C, orange for G, red for T and dark gray for N. The saturation of colours indicates the base qualities and the thickness lines of reads shows the mapping qualities of read alignments. Zooming in/out is supported only in the box view. In both views, the status bar at the bottom of the window will show some information about the key touches, and read names and base qualities pointed by the mouse. .PP Navigating the alignment is accomplished by vaious key bindings. .IP "\(bu" 2 Key bindings: .Sp .Vb 7 \& ? Display help \& Exit \& Sequence view \& Box view \& p Switch to the previous reference sequence \& n Switch to the next reference sequence \& r Refresh \& \& Move to the position pointed by \& h / Move left by one base \& l / Move right by one base \& k / Move up by one line \& j / Move down by one line \& > Move to the next read \& < Move to the previous read \& g / Move to the beginning of the current reference \& G / Move to the end of the current reference \& u / Move left by one page \& / Move right by one page \& Move by 100 bases \& Move by 1000 bases \& \& + Add a new view \& \- Remove the current view \& \& Toggle on/off right auto\-scrolling \& ^b Toggle on/off left auto\-scrolling \& + Zoom in \& \- Zoom out \& 0 Zoom to the default scale \& q Toggle show/hide mapping qualities \& e Toggle display SE/PE mapping qualities \& o Open a new alignment file .Ve .IP "\(bu" 2 Enter an integer and then press to jump to the required position. .IP "\(bu" 2 Enter an integer and then press a key other than to speed up scrolling by the specified factor. .IP "\(bu" 2 Left click and drag the yellow cross in the square to move along the sequence. Right click the reference to highlight a column. .SH "LICENSE" .IX Header "LICENSE" \&\s-1GNU\s0 General Public License (\s-1GPL\s0) .SH "AVAILABILITY" .IX Header "AVAILABILITY" .SH "AUTHORS" .IX Header "AUTHORS" Jue Ruan for writing and maintaining the whole software. .PP Heng Li for testing the program and drafting the documentations. .PP Mengyao Zhao for designing the color schemes.