Skip to content

Empress 1.0.0: First Stable Release

Compare
Choose a tag to compare
@fedarko fedarko released this 21 Nov 01:05
· 53 commits to master since this release
7ad942c

New features

  • Show legends for barplots, and improve legend formatting. (#299)
  • Support drawing barplots in the circular layout. (#297)
  • Support ignoring branch lengths during layout. (#271)
  • Color root nodes of collapsed clades. (#321)
  • In Empire plots: add the ability to double-click on a sample coloring category in Emperor (e.g. body site) and color the tree based on the samples in that category. (#370)
  • In Empire plots: added the ability to show synchronized animations between Emperor and Empress. (#319)
  • When node circles are drawn, they are now drawn for all nodes, regardless of if the node in question has a name given or not. (#348)
  • Add basic PNG export functionality. (#330)
  • Improve SVG export functionality: support exporting barplots, collapsed clades, all shown legends, etc. (#384, #392, #303)
  • Add support for drawing borders around each layer of barplots. (#350)
  • Add the ability to create visualizations without having a table or sample metadata; this splits qiime empress plot into two commands, qiime empress community-plot and qiime empress tree-plot. (#175)
  • Add the ability to use iTOL-style "leaf sorting" in Empress' rectangular and circular layouts, and make this the default. (#170)
  • Add a "Tree Statistics" tab to the side panel showing various stats about the tree. (#179)
  • Support double-clicking on collapsed clades to uncollapse them. (#406)
  • Support reversing color maps. (#418, #423)
  • Support shearing a tree to feature metadata (currently only available for tree-plot). (#419)
  • Support drawing the tree as ultrametric. (#444)

Documentation

  • Document challenges with merging metadata in QIIME 2. (#393)
  • Document that Emperor will be re-installed by Empress. (#401)

Bug fixes

  • Fix a bug in which length scaling would cause certain types of bars to not show up in barplots. (#309)
  • Hide "feature metadata" barplot controls when no feature metadata is available in the visualization. (#316)
  • Fix legend formatting -- ensure all category colors are drawn as equal-dimension boxes. (#331)
  • Fix a small bug where it was possible for barplot layers' UIs to collide. (#340)
  • In Empire plots: Fix timing in Emperor box-selections, allowing multiple repeated selections without strange behavior. (#197)
  • Vary the number of lines used to approximate arcs drawn in the circular layout, based on the angle traveled by the arc. Reduces the amount of lines drawn and also makes particularly long arcs look smoother. (#372)
  • Fix exported SVG images being flipped upside-down relative to the Empress interface. (#334)
  • Fix a small bug in how gradients are drawn. (#421)
  • Ignore root lengths, if available, in the unrooted layout. (#374)
  • Fix a bug with a dependency's code files not being installed with Empress. (#402, #399)
  • Don't collapse clades that contain just a single tip. (#315)
  • Fix a bug where in certain browsers and cases Emperor and Empress' CSS would slightly overlap. (#356)
  • Fix bug where single-tip trees would not be visible in the circular layout. (#429)
  • Fix problems when clicking on nodes not present in the feature table (due to the tree not being sheared). (#314)
  • Hide the Add button, etc. after all sample metadata columns have been summarized in the node selection menu. (#272)

Performance improvements

  • Use the BIOM table object throughout Empress' Python codebase, and speed up usage of it. (#317, #328)
  • Speed up sample metadata barplot computation. (#298)
  • Speed up taxonomy string processing for feature metadata. (#326)
  • Compute tree layouts on-the-fly in JavaScript, rather than in Python. Reduces the size of visualizations, and enables many new features that involve laying out the tree dynamically. (#345)
  • Uses a balanced parentheses representation of the tree throughout Empress' Python codebase in place of the skbio.TreeNode object. (#360, #155)
  • Don't automatically draw barplots when clicking the Draw barplots? checkbox, which can be a very slow operation if the default way of drawing barplots would be inefficient (e.g. sample metadata barplots for a quantitative field). (#343)
  • By default, don't draw node circles. (#349)
  • Compress the way colors are passed to WebGL, saving memory. (#400)
  • Improve node searching for large trees -- only show at most 10 results at a time, use binary search, etc. (#364, #433)

Development enhancements

  • Improve the way Empress/Emperor integration is set up internally. (#383)
  • Removed the pep8 testing requirement. (#397)

Miscellaneous

  • Rename some options in the command-line interface. (#312)
  • Shifted around some controls within the side panel so that things are in more intuitive locations. (#379)
  • In Empire plots: highlight the samples containing a node by enlarging them, rather than by highlighting them. (#373)
  • The default tree color is now a darker shade of gray/black.
  • Adjust default barplot layer thickness. (#442)
  • Don't show duplicate names in node searching. (#433)
  • Show "Unnamed node" as the name for unnamed nodes in the node selection menu.
  • Various other improvements to Empress' CLI, UI, and documentation. It's been a while since the last release!

🏅 🎋 👸

a_lotta_stuff

Acknowledgements

This work is supported by IBM Research AI through the AI Horizons Network. For more information visit the IBM AI Horizons Network website.