Here is all the sweet documentation for using Iroki!! It's still a work in progress....

Newick trees

Iroki reads Newick formatted trees. This is a widely used format for storing phylogenetic and other types of trees in plain text.

Here is an example of a tree with bootstrap support values. In this case, the support values run from 0 - 1, but depending on your tree building software, they might run from 0 - 100, or look super neat like this 95.6/100 if you used IQ-TREE.

Knowing which type of bootstrap support values your tree has will be important if you want to use the inner dots to represent bootstrap support.

((geode:1, (clock:0.5, tire:5.3)0.4:2)0.75:6, (banana:1.7, eggplant:1.5)0.5:3);

You can download this tree here.

This tree will look like this when viewed with Iroki.

Tiny tree with bootstraps

For the rest of the examples, we will use this tree.

Mapping files

Iroki is all about mapping files, so we try to make them as simple to use as possible.

Here is an example mapping file. It's just a sweet screenshot of a spreadsheet.

Tiny tree simple mapping

Mapping files should be tab-delimited. We reccomend making your mapping file in your favorite spreadsheet program and then exporting it as a tab-delimited text file (tsv). Right click here and select Download to get the above mapping file as a tab seperated text file.

Note that Iroki will strip off whitespace from the beginning and end of all tokens in the mapping file.

Styling options

The first row of the mapping file tells Iroki what aspects of the tree that you want to style.

The first column of the first row must always be name.

The above mapping file has all the options currently supported by Iroki. Here they are again:

There are options for styling labels (leaf_label_color, leaf_label_font, leaf_label_size), leaf dots (leaf_dot_color, leaf_dot_size), branches (branch_width, branch_color), and for renaming nodes (new_name).

If you have anything in the first row of your mapping file that is not one of these options, Iroki will let you know about it.

Note that you should only include the styling labels that you actually want to use in your mapping file. This is because Iroki will take whatever is in the mapping file and lock those options in the viewer. For example, if I have leaf_label_color in my header row, then Iroki will lock the option for "Show leaf labels?" to on.

Branch styling

If you have branch styling in your mapping file, Iroki will recursively color as far down as possible. That way you can easily identify clades with the same metadata.

Mapping file priority

Iroki will take whatever is in your mapping file and generate styling options that will override whatever was previously set in the options panel. Here is an example.

First we have a tree and we have manually set the branch color to magenta.

Mapping file priority 1

Next, we upload the mapping file from above. Note that it has branch_color in the header row.

Mapping file priority 2

As you can see, the branch_option is still set to magenta, but the branch colors have been set by the mapping automatically.

Let's look at one more example. This time, the mapping file will only set branch_color for certain clock and tire. You can see the mapping file here.

Mapping file priority 3

As you can see, the clock and tire clade is colored blue (by the mapping file) and the rest of the branches are colored magenta (by the option set by the user in the options panel).