Debian Codegraph @

CHANGES

raw
1
2 7 Mar 2005 - v0.1
3
4 24 May 2005 - v0.2
5
6 A large number of changes. Primarily
7
8 - support for non-linear scale
9 - support for optional tick labels and minimum tick separation
10 - reworked 2D data file formats
11
12 A lot of bugs fixed. Primarily
13
14 - fixed poor text layout on tick labels
15 - fixed support for newer GD (stringFT vs stringTTF)
16
17 25 May 2005 - v0.21
18
19 Added global scaling, described in Tutorial 6.
20
21 23 Jan 2007 - v0.22
22
23 Focused tutorials on figures in NYT article. Added support for multiple fonts. You no longer need to define $FONT yourself.
24
25 17 Oct 2007 - v0.31pre0
26
27 Prelease of 0.31. Nearly everything has been revamped.
28
29 Revamped configuration syntax, making it more intuitive and consistent.
30
31 New tutorials posted. Axes breaks added. More flexible ideogram ordering.
32
33 Significant changes to placement of data elements, now with support for relative and absolute position values.
34
35 18 Oct 2007 - v0.31pre1
36
37 Fixed memory problem when drawing highlights. Now require Set::IntSpan v1.11 or newer.
38
39 Additional sanity checks when loading configuration files.
40
41 23 Oct 2007 - v0.31pre2
42
43 Added tiles and heatmaps.
44
45 26 Oct 2007 - v0.31pre3
46
47 Added scale adjustment.
48
49 28 Oct 2007 - v0.31
50
51 Finalized features in 0.31-preX.
52
53 20 Nov 2007 - v0.32
54
55 Added functionality for histograms to avoid joining neighbouring bins if their spans are not abutting.
56
57 Added ability to define rules based on format characteristics of data (e.g. color, thickness).
58
59 Added "restart" flow control for rules.
60
61 Fixed image output for Windows users.
62
63 3 Dec 2007 - v0.33
64
65 Adjusted ideogram spacing to allow pair-wise spacing definitions based on tag.
66
67 Fixed axis break issue when a break value was required but break parameter was not set.
68
69 Added text labels on ticks.
70
71 22 Dec 2007 - v0.34
72
73 Rewrote label snuggling method.
74
75 Added ability to turn text tracks into glyph tracks.
76
77 Fixed rule condition evaluation to allow broader range of characters.
78
79 24 Dec 2007 - v0.35
80
81 Unit-related error messages now more explicit.
82
83 Various fixes for handling bezier_radius.
84
85 3 Jan 2008 - v0.36
86
87 Imagemap output reformatted and made consistent.
88
89 27 Feb 2008 - v0.37
90
91 Added ability to set image background to transparent or a custom image.
92
93 Adjusted color allocation to avoid duplicate allocation of identical colors.
94
95 9 Apr 2008 v0.38
96
97 Added support for stacked histograms and ability to independently set radius for each link end.
98
99 Fixed histogram fill to drop to y=0 (or closest) level.
100
101 Circos now requires Clone module (http://search.cpan.org/~rdf/Clone-0.28/Clone.pm)
102
103 14 Apr 2008 v0.39
104
105 Added ability to orient ideograms and scale in a counterclockwise orientation using angle_orientation parameter.
106
107 Adjusted the way joined histogram bin stroke is drawn.
108
109 Fixed bug in which joined histograms bins were not being filled in correctly.
110
111 Fixed bug with text offsets at 12 o'clock position.
112
113 21 Apr 2008 v0.40
114
115 Added SVG output support.
116
117 23 Apr 2008 v0.41
118
119 Fixed bug which caused incorrect plot scaling when min>0.
120
121 Fixed a svg bug which caused images with single unspaced ideograms to display incorrectly.
122
123 Adjusted svg-related coded to avoid PNG color palette limitations (you can now have more than 256 colors in color.conf when using svg).
124
125 Modified SVG Bezier curves to use crest parameter.
126
127 28 Apr 2008 v0.42
128
129 Fixed a bug which prevented ribbons from displaying in svg files.
130
131 12 May 2008 v0.43
132
133 Tick labels can be made relative to ideogram length using relative_label.
134
135 Tick spacing can be made relative using rspacing/spacing_type.
136
137 Individual ideograms can be placed at different radius.
138
139 There is now an installation script which adjusts the Perl binary location and tutorial file output directory.
140
141 18 Jun 2008 v0.44
142
143 Fixed bug that prevented scientific notation with capital E from being parsed correctly.
144
145 Fixed bug that prevened tick mark labels from being rounded correctly.
146
147 Default ideogram spacing value can be set to be relative to total size of ideograms.
148
149 The parameter chromosomes_units can be set relative to total size of ideograms.
150
151 Added skip_run and min_value_change options to plots
152
153 The "-" character can be again used in ideogram names
154
155 PNG and SVG files can now be created at the same time
156
157 25 Jun 2008 v0.45
158
159 A variety of speed optimizations were done.
160
161 - GD brush initialization
162 - added memoization to speed up certain function calls
163 - reduced debug reporting overhead
164
165 Overall speed improvement is about 3- to 4-fold for core functions.
166
167 23 July 2008 v0.46
168
169 Fixed ideogram lookup bug when display order was customized.
170
171 Added a variety of helper scripts to create and filter data and to order chromosomes (see tools/)
172
173 Added 24-bit PNG support and adjusted color allocation accordingly
174
175 30 Sep 2008 v0.47
176
177 IMPORTANT: Math::BigFloat is now required.
178
179 Added error trap if old version of GD is used that does not support 24bit flag.
180
181 Added support for alpha channel in PNG images - now colors can have transparency level.
182
183 Fixed brush bug for outlined ribbons with newer GD version.
184
185 Added -show_ticks as a command-line parameter (to unset use -no-show-ticks).
186
187 Added -show_tick_labels as a command-line parameter (to unset use -no-show-tick_labels).
188
189 Added -silent for completely quiet operation (nothing reported to STDOUT).
190
191 Improved tick suppression consistency when tick_separation was defined.
192
193 Precision in tick mark formatting is improved with Math::BigFloat (this module is now needed).
194
195 Added ticks for specific positions via "position" and "rposition" parameter.
196
197 Added connector track (currently experimental). This will be documented in an upcoming release.
198
199 21 Oct 2008 v0.48
200
201 Direction of individual ideograms can be reversed with chromosomes_reverse.
202
203 Twist of ribbons is now correct, with a ribbon linking the start and end coordinates of each span.
204
205 Ribbon twists can be forced with twist=1 or removed with flat=1.
206
207 Individual link coordinates can be inverted by using start>end or inverted=1 parameter.
208
209 Added plot of type=highlight to allow highlights to be drawn at any z-depth.
210
211 Finalized connector track.
212
213 Added band_transparency to allow drawing semi-transparent cytogenetic bands on top of ideograms.
214
215 30 Jan 2009 v0.49
216
217 Optimized calls to Math::Bezier to reduce time taken to draw links.
218
219 Inverted link coordinates (i.e. end<start) can be tested with _REV1_ and _REV2_ in rules.
220
221 Fixed error that caused ends of ribbons to be drawn as straight lines.
222
223 Fixed error that caused highlights to be drawn on top of the grid in certain cases.
224
225 26 Jun 2009 v0.50
226
227 Added file_delim to allow any field delimiter to be used in input files (e.g. a tab).
228
229 Added sanity check for True Type font support in GD.
230
231 Added antialiasing to lines and polygins. Limitations in gd prevent antialiasing of lines that have a thickness >1 pixel or that use a color with an alpha channel.
232
233 Fixed bug with parameter parsing that was using = as a delimiter.
234
235 Added image maps (via the url parameter) to ideograms, bands, ticks, highlights, tiles, ribbons, text, scatter plots, histograms and heat maps. This is described in Tutorial 10.
236
237 Backend implementation has been adjusted, with Circos code moved to Circos.pm module (credit goes to Ken Youens-Clark (CSHL)).
238
239 5 Jul 2009 v0.51
240
241 Added more comprehensive options to show and suppress tick marks based on ideogram and position.
242
243 Fixed scale zooming for display at base resolution.
244
245 Expanded and streamlined tick mark functionality.
246
247 24 Nov 2009 v0.52
248
249 A bug release that fixes issues with ordering and axis breaks.
250
251 Ideogram labels can now be rendered with their baseline parallel to
252 the circle's circumference by using label_parallel=yes in the
253 <ideogram> block.
254
255 17 Jan 2011 v0.53
256
257 Rolled in bug fixes.
258
259 29 Mar 2011 v0.54
260
261 Tile image fills are now supported. Specify the file name instead of the fill color.
262
263 Color lists supported.
264
265 Automated track placement using counters.
266
267 Various bug fixes and error checks.
268
269 13 Apr 2011 v0.54-1
270
271 Factored out color functions to Circos::Colors
272 Factored out configuration functions to Circos::Configuration
273 Factored out constants and strings to Circos::Constants
274 Factored out debug functions to Circos::Debug
275 Factored out image variables to Circos::Image
276 Factored out unit checking functions to Circos::Unit
277 Factored out utility functions to Circos::Utils
278
279 Fixed transparency bug introduced in 0.54. Fixed tableviewer parse-table bug which was triggering error complaining about a missing '='
280
281 Added to README for Windows users.
282
283 16 Jun 2011 v0.55-1
284
285 Multiple karyotype files can be specified as comma-delimited list in 'karyotype' parameter
286
287 Color for chromosomes can be specified with chromosomes_color
288 hs1:red,hs2:blue,...
289
290 Chromosomes can now take a fraction of the entire image by specifying relative scale.
291 hs1:0.25r # hs1 will take up 1/4 of the figure
292
293 Parameters in included configuration files can be overridden using "*" suffix. Any number of *s can be
294 used to indicate priority.
295
296 <ideogram>
297 <<include ideogram.defaults.conf>>
298 # this will override any 'label_radius'
299 label_radius* = dim(ideogram,radius) + 0.25r
300 # this will override any 'label_radius', 'label_radius*', and 'label_radius**'
301 label_radius*** = dim(ideogram,radius) + 0.25r
302 </ideogram>
303
304 Parameter list can now use '=' for assignment, in addition to ':'. Lists that do not expect a span (e.g. chromosomes) can also use ',' as record delimiter. For example, any of these will work.
305
306 chromosomes_scale = chr1:0.5;chr2:0.25
307 chromosomes_scale = chr1:0.5,chr2:0.25
308 chromosomes_scale = chr1=0.5;chr2=0.25
309 chromosomes_scale = chr1=0.5,chr2=0.25
310
311 Transparent colors now include COLOR_a0, which points to the fully opaque version of COLOR. Thus, for a given auto_alpha_steps value (e.g. N=5) COLOR_a0 ... COLOR_aN are available. Previously COLOR_a0 was not available and the name COLOR had to be used (e.g. red instead of red_a0).
312
313 remap(value,min,max,remap_min,remap_max) can now be used in rules, as well as remap_int() to remap to integers (truncation) or remap_round() to remap to integers (rounding).
314
315 chromosomes_scale and chromosomes_color can accept regular expressions for chromosomes. These are evaluated first, followed by literal chromosome definitions.
316
317 chromosomes_scale = /hs/=0.2,hs5=0.5,/hs1/=0.3
318
319 order of scale adjustment:
320
321 1. all chromosomes matching /hs/ set to 0.2
322 2. all chromosomes matching /hs1/ set to 0.3
323 3. hs5 set to 0.5
324
325 'chromosomes' parameter accepts regular expressions, specified using /.../
326
327 chromosomes = /hs/
328 chromosomes = -/hs/
329
330 When chrromosomes_display_default=yes, use chromosomes_order_by_karyotype=yes to order chrs by their order in the karyotype. If this parameter is not set, the order is determined by a sort based on string+digit in the chromosome name (e.g. chr1=chr+1 chr2=chr+2, etc)
331
332 Histograms with transparency fill should now no longer have an outline even if no outline is desired. This artefact was due to how GD rendered antialiased filled polygons.
333
334 Rules for links and plots can have 'use=no' to turn them off.
335
336 Color lists now written to cache to speed up color allocation at run-time.
337
338 Debug groups now available to show running status of components. See etc/housekeeping.conf for a full list
339
340 e.g.
341 summary - summary progress
342 chrfilter - ideogram filtering
343 conf - configuration
344 ideogram - ideogram reports
345 cache - file caching
346 io - file input/output
347 _all - turn on all debugging (very verbose)
348
349 Colors such as vlred (very light red), lred (light red), etc, have been replaced by Brewer palette colors, where possible. For example, the vlred, lred, red, dred, vdred samples the 5 color sequential red palette.
350
351 Multiple counters can be adjusted with pre_increment_counter and other functions using a comma-delimited list
352
353 pre_increment_counter = counter1:10,counter2:15
354
355 Colors have always been forced to lowercase. If a user asked for a color with capitals (e.g. chrX), an error resulted. Now, only a warning is generated (if warnings are turned on) if the lowercase equivalent is found.
356
357 Parallel labels should now be better centered when using label_center for the ideogram label in <ideogram> block.
358
359 Added band_stroke_thickness to <ideogram> block.
360
361 init_counter is now used to initialize a counter value
362
363 Added example/ and moved tutorials to a separate distribution.
364
365 Speeded up the text track.
366
367 Speeded up input io - data points that don't fall on ideograms on the figure are ignored
368
369 10 Sep 2011 v0.56-pre0
370
371 Parallel ideogram labels are now centered with respect to the ideogram.
372
373 restrict_parameter_names now controls whether parameters are restricted to a pre-defined list (e.g. color, thickness, etc). If you have custom parameters (e.g. 'myspecialcode') then set restrict_parameter_names=no. By default, this is always set to 'yes'.
374
375 Added link_orientation for text tracks. When set to "out" links from text labels face out, rather than in.
376
377 28 Oct 2011 v0.56-pre1
378
379 Added font names to SVG files via font-family tag.
380
381 1 Nov 2011 v0.56-pre2
382
383 Removed -verbose. The -v flag now reports version.
384
385 Added -version.
386
387 Removed dependence on Graphics::ColorObject.
388
389 Added error handling framework.
390
391 Circos now requires Text::Format
392
393 Bug fix to heat map color mapping of last color.
394
395 26 Jan 2012 v0.56-pre3
396
397 Fixed bug which was causing line links to be drawn with a thickness half of what was requested.
398
399 Fixed bug that prevented parameters made acceptable by the restrict_parameter_names=no setting from being parsed.
400
401 Configuration file location is now guessed if guess_conf_location=yes (see etc/housekeeping.conf)
402
403 Color file cache can now be static (color_cache_static) and dir/file can be changed (color_cache_{file,dir})
404
405 Added 'placed' and 'not_placed' output for labels in text tracks to. Use -debug_group textplace to see this.
406
407 # create data file of labels that were not placed
408 circos -conf ... -debug_group textplace | grep not_placed > text.notplaced.txt
409
410 Parts of the code were made faster (unit checking) through Memoize.
411
412 Fixed a bug which prevented links with thickness=1 from being shown with correct transparency.
413
414 4 Feb 2012 v0.56-pre4
415
416 Fixed bug in which color errors were produced when PNG file was not asked for.
417
418 Fixed bug in which opacity of links in SVG files was missing in some cases.
419
420 Fixed but which was assigning the wrong color to transparent links in PNG files in some cases.
421
422 Centralized color configuration files colors.conf now includes brewer.conf - no need to include brewer.conf separately.
423
424 Added -paranoid flag to exit on warnings.
425
426 Made error messages friendlier. Revamped internal error handling mechanism.
427
428 5 Feb 2012 v0.56
429
430 Added data_path to allow adding to locations where files are searched for.
431
432 Added data/ to prefix path of locations where files are searched for. Now the default search locations are
433
434 { CWD | CIRCOS_PATH } + { . | .. | ../.. } + { . | etc | data }
435
436 20 Feb 2012 v0.56-1
437
438 Added TTF versions of CMU Bright Roman and CMU Typewriter Regular. The OTF versions are incorrectly displayed by GD, when rotated.
439
440 Fixed bug that prevented regular expressions from being evaluated properly in a chromosome record.
441
442 Speeded up histogram code.
443
444 Speeded up function that draws arcs. If SVG file is not requested, this function now skips SVG-related calculations.
445
446 Fixed bug in init_counter which was causing this function to not be applied.
447
448 Added color_cache_create parameter to toggle creation of cache file on/off.
449
450 Added 'symbol' synonym for 'symbols' font.
451
452 Fixed round_up() utility function.
453
454 Added -chromosomes_display_default command line flag.
455
456 Changed chromosome prefix in Drosophila melanogaster (fruit fly) karyotype to 'dm' and colors to set1-6-qual palette.
457
458 Made the TTF support checking more robust.
459
460 4 May 2012 v0.60
461
462 Added image_map_missing_parameter=ignoreparam to allow URL parameter values with [].
463
464 Fixed bug in extend_bin which prevented extend_bin=no from being correctly interpreted.
465
466 Fixed bug in testing z-depth for plots.
467
468 Fixed bug with angle_offset.
469
470 Links with transparency should now show up correctly in SVG.
471
472 Plot axes should now show up correctly in SVG.
473
474 Fixed a bug which made reversed chromosome segments created with chromosomes_breaks show up in an unintuitive order.
475
476 Fixed behaviour of offset when drawing slices. This fixed a bug that made some slice arcs curve the wrong way.
477
478 Configuration file syntax __$CONF{a}{b}__ can now be replaced with conf(a,b). eval() is needed if the conf value is used in an expression. For example eval(2*conf(a,b)) instead of __2*$CONF{a}{b}__
479
480 Wherever you would use a color name, you can now specify colors using r,g,b or r,g,b,a values. Here 'a' is the alpha channel 0..1 (0=opaque,1=transparent).
481
482 color = red
483 color = 250,50,50
484
485 Added -randomcolor, just for fun.
486
487 Links can be specified on one line in input data file, instead of two
488
489 chr1 start1 end1 chr2 start2 end2 {options}
490
491 <link> blocks no longer need to be named - they now behave like <plot> blocks.
492
493 <links>
494 <link>
495 ...
496 </link>
497 <link>
498 ...
499 </link>
500 ...
501 </links>
502
503 Rules are now ordered in two phases. First, all rules with an
504 'importance' value are placed first, followed by rules that don't have
505 this parameter, in the order that they appear. For example, if the
506 following are rules' importance values ("-" means not defined)
507
508 r1 -
509 r2 0
510 r3 15
511 r4 -
512 r5 20
513
514 the final order will be r5(20),r3(15),r2(0),r1(-),r4(-). Thus, rules
515 don't need the importance parameter at all, if you're happy with their
516 order of appearance.
517
518 Rule flow has been expanded. The flow parameter can now be one of
519
520 flow = continue {if true|false}
521 flow = restart {if true|false}
522 flow = stop {if true|false}
523 flow = goto TAG {if true|false}
524
525 By default, if the condition is not specified, a flow is always
526 triggered. This replaces the behaviour in which the flow triggered
527 only when the rule was passed.
528
529 flow = stop # always stops, regardless of whether rule is passed
530 flow = stop if false # stops if rule is false
531
532 The TAG is assigned to a rule with 'tag'
533
534 <rule>
535 # define a tag for this rule
536 tag = myrule
537 ...
538 </rule>
539
540 <rule>
541 ...
542 # goto the rule with tag=myrule
543 flow = goto myrule
544 </rule>
545
546 You can have multiple flow tags to accomodate different if true/false actions.
547
548 <rule>
549 ...
550 flow = stop if false
551 flow = goto otherrule if true
552 </rule>
553
554 A rule may lack a condition if a flow directive exists. Thus, shortcircuiting all rules can now be done with
555
556 <rule>
557 flow = stop
558 </rule>
559
560 instead of
561
562 <rule>
563 condition = 1
564 flow = stop
565 </rule>
566
567 If you would like to always skip to a rule (e.g. to bypass rules you don't want)
568
569 <rule>
570 flow = goto myrule
571 </rule>
572
573 A rule or configuration may remove a parameter by setting its value to 'undef'. This is useful to remove default.
574
575 <rule>
576 condition = var(value) < 0.5
577 fill_color = undef
578 </rule>
579
580 Added normalized relative scale. Now you can set
581
582 chromosomes_scale = /hs/=0.5rn
583
584 to make all /hs/ equally sized and take up 0.5 of the circle. Previously, you had to do this
585
586 chromosomes_scale = /hs/=0.2083r
587
588 assuming that /hs/ matched 24 chromosomes.
589
590 All tracks now have default settings, taken from etc/tracks.
591
592 4 Jun 2012 v0.61
593
594 Identified a bug in gd that causes problems when lines of thickess 1px are anti-aliased. Added anti_aliasing parameter to turn aa off to mitigate this.
595
596 Fixed bug that caused elements in list defined by chromosomes_colors to be applied in the wrong order.
597
598 Fixed a bug that made backgrounds to be incorrectly oriented for tracks whose orientation is reversed.
599
600 Added skip_missing_expression_vars in etc/housekeeping.conf to allow skipping references to missing parameters with var(NAME).
601
602 Added label_format to <ideogram> block. This parameter allows you to use the same dynamic syntax for labels as you do for rules.
603
604 label_format = eval(var(chr))
605 label_format = eval(var(chr_with_tag))
606 label_format = eval(sprintf("%s %.3fMb",var(chr),var(size)/1e6))
607
608 Changed rebuild_color_cache to color_cache_rebuild.
609
610 Track axes are now defined using <axes> blocks with one or more <axis> entries. Each block can contain one or more of the following parameters: color, thickness, spacing, position, position_skip. Spacing and position parameters can be relative (use r suffix).
611
612 <axes>
613 color = grey
614 thickness = 1
615 <axis>
616 spacing = 0.1r
617 position_skip = 25000
618 </axis>
619 <axis>
620 position = 0.35r
621 color = red
622 </axis>
623 </axes>
624
625 Track background is now defined using <backgrounds> blocks with one or more <background> entries. Each block can contain one or more of the following parameters: color, stroke_{color|thickness}, y0, y1. If y0 and/or y1 are not specified, track minimum and maximum are used, respectively. y0 and y1 can be absolute or relative (use r suffix for relative).
626
627 <backgrounds>
628 <background>
629 color = lgrey
630 </background>
631 <background>
632 y0 = 0.5r
633 color = lgred
634 </background>
635 <background>
636 y1 = 0.5r
637 color = lgreen
638 </background>
639 </backgrounds>
640
641 When cytogenetic bands overlap, a warning is produced instead of fatal error.
642
643 Adjusted code which made v.60 incompatible with perl 5.8 due to a recursive regular expression used to parse rules. Text::Balanced is now used to extract function arguments in balanced parentheses.
644
645 Added conf(.,x) syntax to access value of 'x' in the current block.
646
647 <plot>
648 r0 = 0.8r
649 r1 = conf(.,r0)+0.1r
650 ...
651
652 Top level blocks, such as <ideogram>, <colors>, <fonts>, <image> and <ticks> are merged. This allows you to do something like this
653
654 # define your own color(s)
655 <colors>
656 mycolor = 255,100,100
657 </colors>
658
659 # include default color, fonts and patterns, which brings in
660 # <colors>, <fonts> and <patterns> blocks
661 <<include etc/colors_fonts_patterns.conf>>
662
663 To override a value, don't forget to use *. For example, to hide the ideogram label in tutorial 2.2,
664
665 <ideogram>
666 # * is required at the end of parameter name so that it overrides the
667 # default value of 'show_label' defined in the block imported below
668 show_label* = no
669 </ideogram>
670
671 # default <ideogram> block from file
672 <<include ideogram.conf>>
673
674 snuggle_sampling can now be relative
675
676 max_snuggle_distance = 1r
677 snuggle_sampling = 0.2r
678
679 Text that is not placed can now be explicitly shown using 'overflow'. This text will be placed at r0 of the track. The format of the unplaced text can be controled using overflow_* parmaeters
680
681 overflow = show
682 overflow_font = bold
683 overflow_size = 36
684 overflow_color = red
685
686 25 Jun 2012 v0.62
687
688 Added README and cat, cow and dog assemblies in data/karyotype/assembly.
689
690 Added hs* colors, as synonym for chr* colors (e.g. hs1 <- chr1). This allows assigning chromosome name to color directly for human, instead of remapping hs to chr.
691
692 # previously
693 color = eval(sprintf("chr%s",substr(var(chr1),2)))
694
695 # now
696 color = eval(var(chr1))
697
698 Added ../../.. to file search path. Now, when the parameter 'file' is used Circos will look three directories back. This allows the tutorials to be run in place without moving the data/ directory into the Circos distribution path.
699
700 Added case_sensitive_parameter_names to allow data point parameter case to be respected. Default is case_sensitive_parameter_names=no
701
702 Fixed a bug that was preventing link overlap check in text tracks.
703
704 A bug was preventing backgrounds and axes of tracks from being shown on ideograms that had no data. Added show=data option to <backgrounds> and <axes> to show these elements only for ideograms on which the track has data.
705
706 <backgrounds>
707 show = data
708 <background>
709 ...
710 </background>
711 </backgrounds>
712
713 Added a quick guide tutorial
714
715 http://www.circos.ca/documentation/tutorials/quick_guide/
716
717 Added a check that ensures that the etc/housekeeping.conf file is being included.
718
719 3 July 2012 v0.62-1
720
721 This version includes example/data, which was inadvertantely left out of 0.62.
722
723 5 Feb 2013 v0.63
724
725 Added the ability to change any configuration parameter from the command-line by -param
726
727 -param debug=1 changes 'debug' in root
728 -param image/radius=2000p changes 'radius' in <image> block
729 -param ideogram/spacing/default=0.002r changes 'default' in <spacing> block of <ideogram> block
730
731 A fatal error is triggered if you attempt to adjust a parameter in a block that does not exist.
732
733 Removed the following command-line parameters (use -param PARAM=VALUE instead) :
734
735 chromosomes*
736 show_tick*
737 usertext*
738 background
739 image_map*
740 file_delim
741 tagname
742 cdebug
743
744 The -cdump flag can now take a block, or a block path
745
746 -cdump image
747 -cdump ideogram/spacing
748
749 Absolute file names were improperly parsed on Windows. Fixed this by using the more general File::Spec module.
750
751 Fixed bug that prevented 'minsize' and 'padding' track parameters from being parsed.
752
753 chromosomes_color can now be used with ideogram tags
754
755 chromosomes = cycle[g1]:0-45;cycle[s]:45-80;cycle[g2]:80-95;cycle[m]:95-100
756 chromosomes_color = g1=red,s=orange,g2=green,m=blue
757
758 Added "pure" colors for each named color, accessed with "p" prefix. The ladder is a 10% luminance step. Other colors are pgreen, pblue, ppurple, porange.
759
760 vvlpred vlpred lpred pred dpred vdpred vvdpred
761
762 Fixed a bug in which files specified by an absolute path were not found on Windows.
763
764 Fixed a bug that was reversing connectors with start>end.
765
766 Changed the default value of restrict_parameter_names to 'no'. Now you can add options to data points without having to override this parameter.
767
768 Fixed a bug that was preventing rules from being applied to connectors.
769
770 Speeded up routines that calculated spacing between ideograms.
771
772 Added legacy_underline_expression_syntax to etc/housekeeping.conf to allow turning off for support for data point parameter access using _NAME_ syntax. By default, the parameter is set to 'no'. Set this parameter to 'yes' to support the old syntax.
773
774 The minsize parameter can now be used in a rule to enlarge a data point interval.
775
776 You can now set a default when referencing a variable with var(), e.g. var(id|0). This is useful when you are using optional fields in complex rule conditions or parameters. For example, if not all data points contain the parameter 'recurrence', then using it in a remap function requires that you provide a default
777
778 thickness = eval(remap_int(var(recurrence|0),0,20,1,10))
779
780 The default square brush used in the PNG routines created jaggies for objects with thick strokes (e.g. links with large thickness, when not drawn as ribbons). Implemented round brushes for objects with large thickness using two new parameters in etc/housekeeping.conf.
781
782 round_brush_use = yes
783 round_brush_min_thickness = 5
784
785 Fixed a bug that prevented using a global file option for a track. Now this works
786
787 <plots>
788 file = data.txt
789 <plot>
790 # if 'file' is not specified, data.txt will be used
791 ..
792 </plot>
793 <plot>
794 # if 'file' is not specified, data.txt will be used
795 ..
796 </plot>
797 ...
798
799 A rule can now have multiple conditions, which are evaluated with AND. The following are equivalent
800
801 condition = on(hs1) && var(size) < 1e6
802
803 condition = on(hs1)
804 condition = var(size) < 1e6
805
806 Fixed a bug which was misinterpreting 'padding' for tiles as an expansion of the tile interval.
807
808 Added 'offset' parameter to tiles to allow them to be shifted radially within their layer.
809
810 <rules>
811 <rule>
812 condition = var(type) eq "exon"
813 thickness = 12
814 </rule>
815 <rule>
816 condition = var(type) eq "intron"
817 thickness = 2
818 offset = 5
819 </rule>
820 </rules>
821
822 Fixed a bug that was causing the second bin of some histograms to encroach on the first.
823
824 Reintroduced support for relative units in chromosomes_units parameter. When 'r' is used, the denominator is 10**round(log10(S)) where S is the total size of all ideograms.
825
826 Fixed a bug that was not drawing backgrounds correctly with tiles.
827
828 Fixed a bug that was breaking stacked histograms due to how bin extension works. Bin extension has been turned off for stacked histograms.
829
830 Cytogenetic bands are now drawn after ideogram labels, as not to cover labels that are placed inside the ideogram.
831
832 Fixed a bug which was prevening ideogram spacing from correctly incorporating ideogram scale.
833
834 Circos now looks for files relative to the location of the configuration file, in addition to the current and distribution directories.
835
836 7 Feb 2013 v0.63-1
837
838 Fixed bug in which parameter override (using * suffix) was not working in deep blocks.
839
840 12 Feb 2013 v0.63-2
841
842 Fixed but in which text labels were not respecting when an ideogram's radius was changed with chromosomes_radius.
843
844 Updated example/ to include chromosomes_radius, which now works correctly with text blocks.
845
846 13 Feb 2013 v0.63-3
847
848 The command-line parameters -noshow_ticks and -noshow_tick_labels now work.
849
850 15 Feb 2013 v0.63-4
851
852 Added debug_auto_timer_report in etc/housekeeping.conf to control the length of a run for which timing reports are always generated.
853
854 Added format check for reading bands from karyotype file.
855
856 18 Feb 2013 v0.63-5
857
858 Added karyotype for Sorghum bicolor (http://www.plantgdb.org/SbGDB/) version JGI Sbi1.
859
860 19 Feb 2013 v0.64-pre0
861
862 Added fill_color parameter for line plots. You can now draw line plots with fill using this
863
864 <plot>
865 type = line
866 fill_color = black
867 ...
868 </plot>
869
870 Added the ability to idependently draw outlines and position mark guides for text. Use type=outline or type=cross in the <guides> block. If type is not defined, both will be drawn.
871
872 Nested calls to conf() now work. For example,
873
874 <radius>
875 a = 0.5
876 </radius>
877
878 <plots>
879 <plot>
880 ...
881 strain = a
882 r0 = conf(radius,conf(.,strain))r
883
884 Fixed bug that was prevening undefining of parameters. To undefine a parameter previously set, use undef
885
886 <<include etc/housekeeping.conf>>
887 track_defaults* = undef
888
889 The 'radius' parameter in <ideogram> block now accepts dims(). For example,
890
891 radius = dims(image,radius) - 50p
892
893 15 Mar 2013 v0.64-pre0
894
895 Added three argument versions of on() for testing data point position.
896
897 on(hs2)
898 on(hs2,5Mb,10Mb)
899
900 Added within(), which acts like on() but insists that the data point falls fully within the interval.
901
902 within(hs2,5Mb,10Mb)
903
904 19 Apr 2013 v0.64-pre1
905
906 Properties of ideograms (e.g. chr, label, etc) now available at tick level in image maps.
907
908 2 May 2013 v0.64
909
910 Added code that checks whether a module is available. If not, a
911 specific error is reported that directs the user to the online
912 tutorial that explains how to install missing modules.
913
914 Added alert when too many ideograms, ticks, links, or data points were being drawn. This is controlled by max_* in etc/housekeeping conf, currently set to
915 max_ticks = 5000
916 max_ideograms = 200
917 max_links = 25000
918 max_points_per_track = 25000
919
920 Fixed a bug in which configuration parameters with multiple instances (e.g. condition in rules) weren't parsed correctly for keywords like conf().
921
922 14 May 2013 v0.65
923
924 Counter parameters can now have multiple instances in <plot>, <link> and <highlight> blocks
925
926 <plot>
927 init_counter = thickness:0
928 init_counter = fill:0
929 ...
930 post_increment_counter = thickness:0.5
931 post_increment_counter = fill:2
932 ...
933 </plot>
934
935 pre_increment_counter and post_increment_counter can be used without a counter name, in which case the counter defaults to the block type. This value will be used for each subsequent block, until it is redefined.
936
937 <plot>
938 post_increment_counter = 2 # plot counter incremented by 2 after block is parsed
939 ...
940 </plot>
941
942 The default location of the output file has been changed from the current directory to the configuration file directory. To change this default, see etc/image.generic.conf, which is included from etc/image.conf.
943
944 # old
945 dir = .
946 # new
947 dir = conf(configdir)
948
949 Data points that extend past the end of their ideogram view range can now be trimmed or hidden, along with optional warnings (fatal or not). See the data_out_of_range parameter in etc/housekeeping.conf. The default is trim,warn.
950
951 A <plot> block no longer requires a file parameter. It can be used for drawing axes and/or backgrounds, without any data.
952
953 The fonts/symbols/symbols.otf font how includes hollow glyphs, encoded by lower case letters. Solid glyphs have been moved to upper case.
954
955 small
956 | medium
957 | | large
958 | | |
959 a b c square
960 d e f rhombus
961 g h i triangle up
962 j k l triangle down
963 m n o circle
964
965 upper case - solid
966 lower case - hollow
967
968 Tick multiplier, spacing and position now supports K, M, G and T suffixes (case-insensitive), with an optional trailing "b" (e.g. Kb). Arithmetic (e.g. division) is supported in these values
969
970 multiplier = 1/1Mb # 1e-6
971 spacing = 5Mb # 5000000
972 position = 5kb,10kb,15kb # 5000,10000,25000
973
974 Most data SVG elements can now have attributes for their SVG tags by adding svg* parameters to the data point track. Any parameter that starts with svg (e.g. svgNNN) will be turned into an attribute whose name is derived from the parameter by stripping the leading "svg" out (e.g. NNNN). (e.g. svgid -> id, svgclass -> class).
975
976 hs1 100 200 0.5 svgid=123,svgclass=abc -> <circle ... id="123" class="abc"/>
977
978 Ideograms now accept SVG attributes using svg* parameters in <ideogram> block. These can be eval()'ed
979
980 <ideogram>
981 ...
982 svgclass = eval(var(chr))
983 svgid = eval(sprintf("chrid%s",var(label)))
984
985
986 Added file_rx field to parse only lines from track file that match this regular expression
987
988 file = data.txt
989 file_rx = id=100$
990
991 Fixed a bug that was incorrectly filling under line plots when angle_orientation = counterclockwise.
992
993 16 April 2014 v0.67-pre0
994
995 Histograms and heatmaps now accept 'pattern' parameter.
996
997 Heatmap color encoding now accepts 'color_mapping' parameter (0,1,2) that defines how colors are mapped onto the range of values.
998
999 encodings: 0,1,2,3,...,n,n+1
1000
1001 method min max
1002 0,1 0|0 1 2 ... n n+1|n+1
1003 0 0|001122...445577|7 [min,max] divided uniformly
1004 1 0|01122...4455667|7 division at edges 1/2 of others
1005 2 0|1 2 ... n-1 n|n+1 divided uniformly, 0,n+1 encode data extremes
1006
1007 Heatmap pattern encoding accepts analogous 'pattern_mapping' (0,1,2).
1008
1009 Added 'legend' debug group to report color mapping legend for each heatmap.
1010
1011 -debug_group legend
1012 debuggroup legend 3.61s track_0 -inf 0.000 inf 0 black 0,0,0
1013 debuggroup legend 3.61s tracko_0 0.000 1.000 1.000 0 black 0,0,0
1014 debuggroup legend 3.61s track_0 1.000 2.000 1.000 1 spectral-8-div-1 213,62,79
1015 debuggroup legend 3.61s track_0 2.000 3.000 1.000 2 spectral-8-div-2 244,109,67
1016 debuggroup legend 3.61s track_0 3.000 4.000 1.000 3 spectral-8-div-3 253,174,97
1017 debuggroup legend 3.61s track_0 4.000 5.000 1.000 4 spectral-8-div-4 254,224,139
1018 debuggroup legend 3.61s track_0 5.000 6.000 1.000 5 spectral-8-div-5 230,245,152
1019 debuggroup legend 3.61s track_0 6.000 7.000 1.000 6 spectral-8-div-6 171,221,164
1020 debuggroup legend 3.61s track_0 7.000 8.000 1.000 7 spectral-8-div-7 102,194,165
1021 debuggroup legend 3.61s track_0 8.000 9.000 1.000 8 spectral-8-div-8 50,136,189
1022 debuggroup legend 3.61s track_0 9.000 10.000 1.000 9 grey 150,150,150
1023 debuggroup legend 3.61s track_0 10.000 +inf inf 9 grey 150,150,150
1024
1025 2 May 2014 v0.67-pre3
1026
1027 Fixed a bug that was preventing
1028
1029 param = undef
1030
1031 from being recognized. This was incorrectly being replaced by the default value of the parameter, making it difficult to remove the effect of the default (e.g. fill color on glyphs).
1032
1033 The default output image directory is now . (current directory), not the configuration file directory. To change this back, edit etc/image.generic.conf.
1034
1035 Added -modules flag so that now modules can be tested using the circos binary.
1036
1037 circos -modules
1038
1039 When Circos is run and modules are missing, a list of all missing modules is shown. Previously Circos exited at the first module.
1040
1041 Fixed a bug that was incorrectly parsing <link> blocks that had no parameters (all inherited from <links> block) but had a <rules> block.
1042
1043 Fixed a bug that was incorrectly parsing comma-delimited parameters for stacked histograms. The values were being split on commas but did not allow for a space around the comma.
1044
1045 Rules can now access track statistics via var(plot_STAT) where STAT is one of
1046
1047 min, max, average (also avg, mean), sd, var, n
1048
1049 Rules can now access additional data point properties with var(FIELD) where FIELD is one of
1050
1051 i prev_value next_value prev_delta next_delta
1052
1053 Updated Brewer palette file. Removed -LETTER colors (e.g. reds-3-seq-a). These never seemed to be used. Added integrated 13-color and 15-color palettes for all sequential and diverging palettes, which are composed of all the colors from which the n-color palettes are sampled.
1054
1055 3 Jun 2014 v0.67-pre4
1056
1057 Fixed bug with heatmap boundaries.
1058
1059 13 Jun 2014 v0.67-pre5
1060
1061 Fixed a bug that was interfering with color allocation when a background image was used.
1062
1063 21 Aug 2014 v0.67-pre6
1064
1065 Added pattern fill support in SVG files. SVG patterns are defined in etc/patterns.svg.conf.
1066
1067 If the path to the parameter set using -param refers to multiple blocks, then this parameter is set in all the blocks. For example,
1068
1069 -param plots/plot/a=1
1070
1071 will set a=1 in each <plot> block
1072
1073 8 Sep 2014 v0.67-pre7
1074
1075 Coordinates in data and karyotype files can now have thousands separators , and _
1076
1077 HEX color format (AABBCC) can now be used anywhere a color name is used. Do not use # in front of the color name.
1078
1079 Options now allow for ,'s within option values.
1080
1081 x=1,y=(2,3),z=a,b,c=5
1082
1083 will be parsed as x=1 y=2,3 z=a,b c=5
1084
1085 Added options_record_delim and options_field_delim for delimiters for option lists in data files.
1086
1087 Options lists now use both , and ; as a delimiter. This can be changed with options_record_delim in etc/housekeeping.conf
1088
1089 Tiles, highlights and connector tracks can now use data files that contain values to make them compatible with data files for track types like scatter plots and text tracks. The requirement that values be numbers has been removed -- any string is now acceptable, but numbers are still required if you're using tracks that require numbers (e.g. histogram, scatter, heatmap etc).
1090
1091 Fixed a roundoff bug for track axes that was preventing the last axis grid from being drawn.
1092
1093 Axes now have default settings defined in etc/tracks/axis.conf
1094
1095 Scatter and tile tracks now behave just like heatmaps. The value of for each tile will be encoded by a color if the color definition is a color list.
1096
1097 Tile tracks now use 'sort' and 'sort_direction' field to determine the order in which tiles are placed in layers.
1098
1099 sort = value | size
1100 sort_direction = ascending | descending
1101
1102 Colors can now be specified in LCH space using lch(l,c,h). This is the perceptually uniform version of hsv.
1103
1104 The -cdump option now accepts both , and / as delimiter for block paths
1105
1106 -conf ideogram/spacing
1107 -conf ideogram,spacing
1108
1109 The -cdump option now accepts a regexp after the block path to filter the elements reported
1110
1111 -conf ideogram:fill
1112 -conf colors:reds
1113 -conf :default
1114
1115 The flags -dir and -file can now be used instead of -outputdir and -outputfile. The -file and -outputfile flags now can contain paths. The following are equivalent
1116
1117 -file etc/circos.png
1118 -dir etc -file circos.png
1119
1120 If the output directory does not exist, a fatal error is produced.
1121
1122 The -time flag now reports timing information. This is a shortcut to -debug_flag +timer
1123
1124 8 Sep 2014 v0.67-pre7
1125
1126 C-style comments /* ... */ are no longer supported in the
1127 configuration file. The reason for this is that regular expressions
1128 like /.*/ interfere with parsing. Instead, use "#" for comments
1129
1130 Using -debug_group without an argument lists the supported groups.
1131
1132 Module check at the beginning now reports the module loading error. It should be clear when a module is out-of-date.
1133
1134 1 Oct 2014 v0.67
1135
1136 Added auto_eval in etc/housekeeping.conf to allow automatic evaluation of all parameter values in rules.
1137
1138 Using var(?) anywhere in the config file will dump a list of available parameters.
1139
1140 Fixed a bug with highlights that was drawing them multiple times for cropped ideogram regions from the same chromosome.
1141
1142 <highlight> blocks can now have <rules>
1143
1144 <ideogram> block can now have rules that apply formatting to each ideogram.
1145
1146 Fixed a bug that was not drawing ticks when show_label=no.
1147
1148 6 Oct 2014 v0.67-1
1149
1150 Fixed cases that were producing warnings with newer versions of Perl.
1151
1152 14 Nov 2014 v0.67-1
1153
1154 Fixed bug with tick positions "start" and "end" not showing up on different cropped regions of the same chromosome.
1155
1156 Fixed bug for regular expression checks in chromosomes_color
1157
1158 18 Nov 2014 v0.67-2
1159
1160 Fixed a tick bug introduced in v0.67-1.
1161
1162 25 Nov 2014 v0.67-3
1163
1164 To draw all axis breaks of style 2 as double lines (including start/end breaks) use
1165
1166 <style>
1167 ...
1168 double_line = yes
1169 </style>
1170
1171 Added karyotype for GRCh38/hg39 (Dec 2013) human assembly, as data/karyotype/karyotype.human.hg38.txt.
1172
1173 27 Nov 2014 v0.67-4
1174
1175 Ideograms can now be filled with a pattern. In <ideogram> use
1176
1177 fill_pattern = checker
1178
1179 19 Jan 2015 v0.67-5
1180
1181 Added arrows to symbols font.
1182
1183 Fixed bug that was making Circos look for a file named after the 'background' parameter in <image>.
1184
1185 Fixed bug with ideogram rules and labels. Now ideogram_label can be altered by a rule.
1186
1187 27 Feb 2015 v0.67-6
1188
1189 Experimental support for superscripts and subscripts in SVG output.
1190
1191 a_i
1192 a_{ijk}
1193 a^2
1194 a^{234}
1195
1196 Baseline and font size shifts are defined in etc/housekeeping.conf using sub_baseline_shift and sub_fontsize and analogous for sup_*.
1197
1198 16 Mar 2015 v0.67-7
1199
1200 Fixed a color bug that was ignoring transparency values in color definitions in data files.
1201
1202 17 Mar 2015 v0.67-8
1203
1204 Added current directory and command to error reporting.
1205
1206 Added specific error report for undefined and ambiguous options.
1207
1208 7 Apr 2015 v0.68-pre1
1209
1210 Fixed a bug that was preventing background to be drawn in SVG files.
1211
1212 10 Jul 2015 v0.68-pre2
1213
1214 Fixed a bug that was introduced in the previous release that broke abbreviation of command-line flags.
1215
1216 16 Nov 2015 v0.68-1
1217
1218 Fixed axis spacing bug that was causing an infinite loop when min=max and spacing was relative.
1219
1220 Fixed a bug in tick filtering which was unnecessarily looping over ticks that were filtered out entirely from an ideogram.
1221
1222 25 Nov 2015 v0.69
1223
1224 The name of the symbols font has been changed from Symbols-Roman to CircosSymbols. See fonts/symbols
1225
1226 Fixed SVG regular expression that was creating a warning due to unmatched {. Now { need to be escaped or used as a character class [{] [}].
1227
1228 Nested calls to var() in rules are now possible. For example,
1229
1230 <rule>
1231 ...
1232 type = a
1233 </rule>
1234 <rule>
1235 ...
1236 value = var(var(type)) # calls var(a)
1237 </rule>
1238
1239 Stacked histograms can now be normalized using
1240
1241 normalize_bin_values = yes
1242
1243 which can be used in combination with
1244
1245 sort_bin_values = yes
1246
1247 To have a track plotted inside an ideogram (useful for highlights) use
1248
1249 inside_ideogram = yes
1250
1251 # equivalent to
1252 r0 = dims(ideogram,radius_inner)
1253 r1 = dims(ideogram,radius_outer)
1254
1255
1256 25 Feb 2016 v0.69-1
1257
1258 Fixed an error that was causing issues in parsing SVG parameters in a connector track.
1259
1260 30 Mar 2016 v0.69-2
1261
1262 Fixed a bug in the output of the heatmap legend that was breaking how RGB values of a color were shown.
1263
1264 24 Jun 2016 v0.69-3
1265
1266 Added a commented chrM to data/karyotype/karyotype.human.hg38.txt to complement the chrM band definition to fix a bug that was preventing the file from being parsed. Note that both chr and band definitions for chrM are commented out, since most figures will not require this chromosome.
1267
1268 Fixed text track so that r0 can be changed using rules.
1269
1270 17 Jan 2017 v0.69-4
1271
1272 Fixed harmless warning in heatmap legend output.
1273
1274 Fixed bug that was displaying ideogram labels at the wrong position when chromosomes_radius was used to change ideogram radius.
1275
1276 2 May 2017 v0.69-5
1277
1278 Removed error due to __ in configuration file. The use of __ for setting values was deprecated for a while now.
1279
1280 9 Jun 2017 v0.69-6
1281
1282 Added the ability to refer to colors using rgb(), hsv(), lch() and hex() wherever a color name is requested. The four argument is optional e.g. lch(80,50,25,0.5) and corresponds to transparency in the range 0 (opaque) to 1 (transparent). When definining HEX colors the transparency is an optional second argument.
1283
1284 rgba() can now be used in color definitions wherever rgb() is used. Both can take 3 or 4 arguments.
1285
1286 # without transparency
1287 red = 255,0,0
1288 red = rgb(255,0,0)
1289 red = rgba(255,0,0)
1290 red = FF0000
1291 red = hex(FF0000)
1292 red = hsv(0,1,1)
1293 # with transparency
1294 red_trans = 255,0,0,0.5
1295 red_trans = rgb(255,0,0,0.5)
1296 red_trans = rgba(255,0,0,0.5)
1297 red_trans = FF0000,0.5
1298 red_trans = hex(FF0000,0.5)
1299 red_trans = hsv(0,1,1,0.5)
1300
1301 hex() can now be used in color definitions wherever a hexadecimal string would normally be used.
1302
1303 The layer in which a tile appears can now be forced using 'layer'.
1304
1305 # define some parameter that stores the layer
1306 chr1 10 20 0.5 i=0
1307 chr1 30 50 0.5 i=0
1308 chr1 70 90 0.5 i=0
1309 chr1 15 20 0.5 i=1
1310 chr1 25 30 0.5 i=1
1311 ...
1312
1313 # specify the parameter to use via 'layer'
1314 <plot>
1315 type = tile
1316 ...
1317 layer = i
1318 ...
1319 </plot>
1320
1321 12 Nov 2017
1322
1323 Fixed SVG stroke opacity bug that was inverting opacity.