~ubuntu-branches/ubuntu/utopic/circos/utopic-proposed

Speeded up input io - data points that don't fall on ideograms on the figure are ignored

 

10 Sep 2011 v0.56-pre0

 

Parallel ideogram labels are now centered with respect to the ideogram.

 

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'.

 

Added link_orientation for text tracks. When set to "out" links from text labels face out, rather than in.

 

28 Oct 2011 v0.56-pre1

 

Added font names to SVG files via font-family tag. 

 

1 Nov 2011 v0.56-pre2

 

Removed -verbose. The -v flag now reports version.

 

Added -version.

 

Removed dependence on Graphics::ColorObject.

 

Added error handling framework. 

 

Circos now requires Text::Format

 

Bug fix to heat map color mapping of last color.

 

26 Jan 2012 v0.56-pre3

 

Fixed bug which was causing line links to be drawn with a thickness half of what was requested.

 

Fixed bug that prevented parameters made acceptable by the restrict_parameter_names=no setting from being parsed.

 

Configuration file location is now guessed if guess_conf_location=yes (see etc/housekeeping.conf)

 

Color file cache can now be static (color_cache_static) and dir/file can be changed (color_cache_{file,dir})

 

Added 'placed' and 'not_placed' output for labels in text tracks to. Use -debug_group text to see this.

 

   # create data file of labels that were not placed

   circos -conf ... -debug_group text | grep not_placed > text.notplaced.txt

 

Parts of the code were made faster (unit checking) through Memoize.

 

Fixed a bug which prevented links with thickness=1 from being shown with correct transparency.

 

4 Feb 2012 v0.56-pre4

 

Fixed bug in which color errors were produced when PNG file was not asked for.

 

Fixed bug in which opacity of links in SVG files was missing in some cases.

 

Fixed but which was assigning the wrong color to transparent links in PNG files in some cases.

 

Centralized color configuration files colors.conf now includes brewer.conf - no need to include brewer.conf separately.

 

Added -paranoid flag to exit on warnings.

 

Made error messages friendlier. Revamped internal error handling mechanism.

 

5 Feb 2012 v0.56

 

Added data_path to allow adding to locations where files are searched for.

 

Added data/ to prefix path of locations where files are searched for. Now the default search locations are

 

  { CWD | CIRCOS_PATH } + { . | .. | ../.. } + { . | etc | data }

 

20 Feb 2012 v0.56-1

 

Added TTF versions of CMU Bright Roman and CMU Typewriter Regular. The OTF versions are incorrectly displayed by GD, when rotated.

 

Fixed bug that prevented regular expressions from being evaluated properly in a chromosome record.

 

Speeded up histogram code.

 

Speeded up function that draws arcs. If SVG file is not requested, this function now skips SVG-related calculations.

 

Fixed bug in init_counter which was causing this function to not be applied.

 

Added color_cache_create parameter to toggle creation of cache file on/off.

 

Added 'symbol' synonym for 'symbols' font.

 

Fixed round_up() utility function.

 

Added -chromosomes_display_default command line flag.

 

Changed chromosome prefix in Drosophila melanogaster (fruit fly) karyotype to 'dm' and colors to set1-6-qual palette.

 

Made the TTF support checking more robust. 

 

4 May 2012 v0.60

 

Added image_map_missing_parameter=ignoreparam to allow URL parameter values with [].

 

Fixed bug in extend_bin which prevented extend_bin=no from being correctly interpreted.

 

Fixed bug in testing z-depth for plots.

 

Fixed bug with angle_offset.

 

Links with transparency should now show up correctly in SVG.

 

Plot axes should now show up correctly in SVG.

 

Fixed a bug which made reversed chromosome segments created with chromosomes_breaks show up in an unintuitive order.

 

Fixed behaviour of offset when drawing slices. This fixed a bug that made some slice arcs curve the wrong way.

 

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}__

 

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..127 (0=opaque,127=transparent).

 

  color = red

  color = 250,50,50

 

Added -randomcolor, just for fun.

 

Links can be specified on one line in input data file, instead of two

 

  chr1 start1 end1 chr2 start2 end2 {options}

 

<link> blocks no longer need to be named - they now behave like <plot> blocks. 

 

  <links>

     <link>

        ...

     </link>

     <link>

        ...

     </link>

     ...

  </links>

 

Rules are now ordered in two phases. First, all rules with an

'importance' value are placed first, followed by rules that don't have

this parameter, in the order that they appear. For example, if the

following are rules' importance values ("-" means not defined)

 

  r1 -

  r2 0

  r3 15

  r4 -

  r5 20

 

the final order will be r5(20),r3(15),r2(0),r1(-),r4(-). Thus, rules

don't need the importance parameter at all, if you're happy with their

order of appearance.

 

Rule flow has been expanded. The flow parameter can now be one of

 

  flow = continue {if true|false}

  flow = restart {if true|false}

  flow = stop {if true|false}

  flow = goto TAG {if true|false}

 

By default, if the condition is not specified, a flow is always

triggered. This replaces the behaviour in which the flow triggered

only when the rule was passed.

 

  flow = stop          # always stops, regardless of whether rule is passed

  flow = stop if false # stops if rule is false

 

The TAG is assigned to a rule with 'tag'

 

  <rule>

  # define a tag for this rule

  tag = myrule

  ...

  </rule>

 

  <rule>

  ...

  # goto the rule with tag=myrule

  flow = goto myrule

  </rule>

 

You can have multiple flow tags to accomodate different if true/false actions.

 

  <rule>

  ...

  flow = stop if false

  flow = goto otherrule if true

  </rule>

 

A rule may lack a condition if a flow directive exists. Thus, shortcircuiting all rules can now be done with

 

  <rule>

  flow = stop

  </rule>

 

instead of 

 

  <rule>

  condition = 1

  flow = stop

  </rule>

 

If you would like to always skip to a rule (e.g. to bypass rules you don't want)

 

  <rule>

  flow = goto myrule

  </rule>

 

A rule or configuration may remove a parameter by setting its value to 'undef'. This is useful to remove default.

 

  <rule>

  condition = var(value) < 0.5

  fill_color = undef

  </rule>  

 

Added normalized relative scale. Now you can set

 

  chromosomes_scale = /hs/=0.5rn

 

to make all /hs/ equally sized and take up 0.5 of the circle. Previously, you had to do this

 

   chromosomes_scale = /hs/=0.2083r

 

assuming that /hs/ matched 24 chromosomes.

 

All tracks now have default settings, taken from etc/tracks.

 

4 Jun 2012 v0.61

 

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.

 

Fixed bug that caused elements in list defined by chromosomes_colors to be applied in the wrong order.

 

Fixed a bug that made backgrounds to be incorrectly oriented for tracks whose orientation is reversed.

 

Added skip_missing_expression_vars in etc/housekeeping.conf to allow skipping references to missing parameters with var(NAME).

 

Added label_format to <ideogram> block. This parameter allows you to use the same dynamic syntax for labels as you do for rules.

 

  label_format = eval(var(chr))

  label_format = eval(var(chr_with_tag))

  label_format = eval(sprintf("%s %.3fMb",var(chr),var(size)/1e6))

 

Changed rebuild_color_cache to color_cache_rebuild.

 

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).

 

  <axes>

   color = grey

   thickness = 1

   <axis>

   spacing = 0.1r 

   position_skip = 25000

   </axis>

   <axis>

   position = 0.35r

   color = red

   </axis>

  </axes>

 

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).

 

  <backgrounds>

   <background>

   color = lgrey

   </background>

   <background>

   y0 = 0.5r

   color = lgred

   </background>

   <background>

   y1 = 0.5r

   color = lgreen

   </background>

  </backgrounds>

 

When cytogenetic bands overlap, a warning is produced instead of fatal error.

 

Adjusted code which made v6.0 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.

 

Added conf(.,x) syntax to access value of 'x' in the current block.

 

  <plot>

  r0 = 0.8r

  r1 = conf(.,r0)+0.1r

  ...

 

Top level blocks, such as <ideogram>, <colors>, <fonts>, <image> and <ticks> are merged. This allows you to do something like this

 

  # define your own color(s)

  <colors>

  mycolor = 255,100,100

  </colors>

 

  # include default color, fonts and patterns, which brings in 

  # <colors>, <fonts> and <patterns> blocks

  <<include etc/colors_fonts_patterns.conf>>

 

To override a value, don't forget to use *. For example, to hide the ideogram label in tutorial 2.2,

 

  <ideogram>

  # * is required at the end of parameter name so that it overrides the

  # default value of 'show_label' defined in the block imported below

  show_label* = no

  </ideogram>

  

  # default <ideogram> block from file

  <<include ideogram.conf>>

 

snuggle_sampling can now be relative

 

  max_snuggle_distance = 1r

  snuggle_sampling = 0.2r

 

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

 

  overflow       = show

  overflow_font  = bold

  overflow_size  = 36

  overflow_color = red