itol_multibar: create itol multi-bar file

View source: R/itol.R

itol_multibarR Documentation

create itol multi-bar file

Description

https://itol.embl.de/help.cgi#multibar

Usage

itol_multibar(
  df,
  dataset_label,
  out_file = "itol_multibar.txt",
  out_dir = getwd(),
  legend = NULL,
  WIDTH = 200,
  COLOR = "#ff0000"
)

Arguments

df

A data.frame, tibble, or data.table (see above)

dataset_label

What to label the itol dataset

out_file

Name of the output file

out_dir

Where to write the output

legend

A list that includes shapes, colors, and labels (see itol_colorstrip)

WIDTH

Bar width

COLOR

Legend color

Details

If a data.frame is provided, the row names must exactly match the tree node labels. If a data.table or tibble is provided, the first column values must exactly match the tree node labels. All other columns are assumed to be values for plotting.

Examples

# data.frame
df = data.frame(value1 = c(1,2,3), value2 = c(3,2,1), row.names = LETTERS[1:3])
itol_multibar(df, 'test_label')
# data.table
dt = data.table(taxa = LETTERS[1:3], value1 = c(1,2,3), value2 = c(3,2,1))
itol_multibar(dt, 'test_label')

leylabmpi/LeyLabRMisc documentation built on Nov. 3, 2022, 3:45 p.m.