.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" 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 "CIRCOS 1" .TH CIRCOS 1 "2014-04-29" "perl v5.18.2" "User Contributed Perl Documentation" .\" 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" .Vb 5 \& _\|_\|_\|_ _ \& / _\|_\|_(_)_ _\|_ _\|_\|_ _\|_\|_ _\|_\|_ \& | | | | \*(Aq_\|_/ _\|_/ _ \e/ _\|_| \& | |_\|_\|_| | | | (_| (_) \e_\|_ \e \& \e_\|_\|_\|_|_|_| \e_\|_\|_\e_\|_\|_/|_\|_\|_/ \& \& round is good .Ve .PP circos \- generate circularly composited information graphics .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& circos \-conf circos.conf [\-silent] [\-help] [\-man] \& \& # detailed debugging for code components \& # see http://www.circos.ca/documentation/tutorials/configuration/debugging \& circos \-debug_group GROUP1,[GROUP2,...] \& \& # configuration dump \& circos \-cdump [BLOCK1/[BLOCK2/...]] \& \& # overriding configuration parameters \& circos \-param image/radius=2000p \-param ideogram/show=no .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Circos is a software package for visualizing data and information. It visualizes data in a circular layout, which makes Circos ideal for exploring relationships between objects or positions. There are other reasons why a circular layout is advantageous, not the least being the fact that it is attractive. .PP Circos is ideal for creating publication-quality infographics and illustrations with a high data-to-ink ratio, richly layered data and pleasant symmetries. You have fine control each element in the figure to tailor its focus points and detail to your audience. .SH "CONFIGURATION" .IX Header "CONFIGURATION" Settings are meant to be passed using a plain-text configuration file. This file can be created manually or by another script, which allows Circos to be fully automated. .PP For full documentation, see .PP .Vb 1 \& L .Ve .SS "Syntax" .IX Subsection "Syntax" Configuration is plain-text and composed of hierarchical blocks. Some blocks, such as \f(CW\*(C` are mandatory, while others like \&\f(CW\*(C` are optional. .PP To get started, refer to the quick guide tutorial. .PP .Vb 1 \& L .Ve .PP A typical configuration file might look like this .PP .Vb 4 \& # image size and format \& \& ... \& \& \& # position and size of ideograms \& \& ... \& \& \& # position, type and format of data tracks \& \& \& ... \& \& ... \& \& \& # colors, fonts and fill patterns \& <> \& \& # system parameters \& <> .Ve .SS "Modularity" .IX Subsection "Modularity" The \f(CW\*(C`<> directive imports one configuration file into another. This facility helps to keep configuration files modular. .PP Parameter definitions that do not frequently change, such as color and font definitions, are conventionally imported from files found in \fIetc/\fR in the distribution. .PP In the tutorials, you'll find that the \f(CW\*(C` and \f(CW\*(C` blocks are imported into the main configuration file. Because these blocks can get quite large, the main configuration file is more legible if they are relegated to separate files. .SS "Overriding with *" .IX Subsection "Overriding with *" To override a parameter that has been included from a file, use the \f(CW\*(C`*\*(C'\fR suffix. The suffix is required because multiple definitions of a parameter are not allowed, except in cases where a parameter is may have more than one value. .PP .Vb 6 \& \& # included file defines \*(Aqradius\*(Aq \& <> \& # this will override the radius value \& radius* = 2500p \& .Ve .PP The \f(CW\*(C`*\*(C'\fR suffix can be repeated to specify which value takes precedence in a block. .PP .Vb 3 \& radius = 1500p \& radius* = 2500p \& radius** = 3000p # this instance of radius will be used .Ve .SS "Overriding with Command Line" .IX Subsection "Overriding with Command Line" Any configuration parameter in a unique block name can be specified on the command line using .PP .Vb 1 \& \-param PATH/PARAM=value .Ve .PP For example, .PP .Vb 5 \& # \& # show = no \& # ... \& # \& \-param ideogram/show=no \& \& # \& # \& # default = 0.01r \& # \& # ... \& # \& \-param ideogram/spacing/default=0.01r .Ve .PP Multiple parameters can be redefined, each with its own \f(CW\*(C`\-param\*(C'\fR flag .PP .Vb 1 \& \-param show_ticks=no \-param image/radius=2000p .Ve .SS "Merging Blocks" .IX Subsection "Merging Blocks" Multiple instances of the following blocks are automatically merged: \f(CW\*(C`, \f(CW\*(C`, \f(CW\*(C`, \f(CW\*(C`, \f(CW\*(C`, \f(CW\*(C`, \f(CW\*(C` and \f(CW\*(C`. .PP The purpose of this is to allow you to add to canonical definitions. .PP .Vb 2 \& # this file defines default , and \& <> \& \& # add to the colors block \& \& mycolor = 150,25,25 \& .Ve .SH "OPTIONS" .IX Header "OPTIONS" .SS "Configuration" .IX Subsection "Configuration" .IP "\-configfile \s-1FILE\s0" 4 .IX Item "-configfile FILE" Name of configuration file. This is required. .Sp Circos will attempt to guess the location of this file, searching for \&\f(CW\*(C`circos.conf\*(C'\fR in \f(CW\*(C`.\*(C'\fR, \f(CW\*(C`..\*(C'\fR, and \f(CW\*(C`../..\*(C'\fR. .SS "Output Format" .IX Subsection "Output Format" .IP "\-png, \-nopng" 4 .IX Item "-png, -nopng" .PD 0 .IP "\-svg, \-nosvg" 4 .IX Item "-svg, -nosvg" .PD Toggles output of \s-1PNG\s0 and \s-1SVG\s0 files. .SS "Output Paths" .IX Subsection "Output Paths" .IP "\-outputdir \s-1DIR\s0" 4 .IX Item "-outputdir DIR" .PD 0 .IP "\-outputfile \s-1FILE\s0" 4 .IX Item "-outputfile FILE" .PD Change the output directory and filename. .SS "Debugging" .IX Subsection "Debugging" .IP "\-debug \s-1LEVEL\s0" 4 .IX Item "-debug LEVEL" Turn on debugging output. .IP "\-debug_group \s-1GROUP1\s0,[\s-1GROUP2,...\s0]" 4 .IX Item "-debug_group GROUP1,[GROUP2,...]" Turn on debugging output for specific groups. For a list of groups, see .Sp .Vb 1 \& L .Ve .IP "\-silent" 4 .IX Item "-silent" Generate no reporting. .SS "Usage" .IX Subsection "Usage" .IP "\-version" 4 .IX Item "-version" Show the version. .IP "\-help" 4 .IX Item "-help" Show brief usage synopsis. .IP "\-man" 4 .IX Item "-man" Show man page. .SH "AUTHOR" .IX Header "AUTHOR" Martin Krzywinski martink@bcgsc.ca .SH "RESOURCES" .IX Header "RESOURCES" .SH "CITING" .IX Header "CITING" If you are using Circos in a publication, please cite as .PP Krzywinski, M., J. Schein, I. Birol, J. Connors, R. Gascoyne, D. Horsman, S. Jones, and M. Marra. 2009. Circos: an Information Aesthetic for Comparative Genomics. Genome Res 19:1639\-1645. .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" Ken Youens-Clark kyclark@gmail.com .SH "SEE ALSO" .IX Header "SEE ALSO" Hive plots .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2004\-2012 Martin Krzywinski, all rights reserved. .PP This file is part of the Genome Sciences Centre Perl code base. .PP This script is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This script is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this script; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA 02111\-1307 USA\s0