plot_col_tree: Plot colonies' lineage tree

Description Usage Arguments Prerequisites

Description

Plots the colonies' lineage tree.

Usage

1
2
3
plot_col_tree(col_list, Ncols, sizeV = 2, sizeE = 0.7, sizeL = 1,
  save = FALSE, savePars = list(w = 2000, h = 2000, res = 250, path =
  getwd(), name = "my_col_tree"))

Arguments

col_list

A list containing all the colony instants of the movie.

Ncols

Number of colonies in the movie, a non-zero positive integer value.

sizeV

Size of vertices, a non-zero positive numeric value. The default value is 2.

sizeE

Width of edges, a non-zero positive numeric value. The default value is 0.7.

sizeL

Size of explanatory legends and title, a non-zero positive numeric value. The default value is 1.

save

A logical value (TRUE or FALSE) indicating whether the generated plot will be saved in a .png file or displayed in the Plots Pane of RStudio, respectively. The default value is FALSE.

savePars

A named list specifying the parameters of the generated image file. This argument is ignored in case save = FALSE. Elements of the list are the following:

w

The width of the image file in pixels, a non-zero positive integer value. The default value is 2000.

h

The height of the image file in pixels, a non-zero positive integer value. The default value is 2000.

res

The resolution of the image file in pixels per inch (ppi), a non-zero positive integer value. The smaller this value, the larger the plot area in inches, and the smaller the text relative to the graph itself. The default value is 250.

path

A character string naming the directory where the image file will be saved (excluding the last "/"). If it does not contain an absolute path, the image file will be saved relative to the current working directory getwd(). The default value is the current working directory getwd().

NOTE: The components should be separated by "/") on Windows.

name

The image file name, a character string. The suffix ".png" is added automatically. The default value is "my_col_tree".

Prerequisites

This function can be used by BaSCA users, importing the data with import_basca.

Users of Oufti or SuperSegger who imported the data with import_oufti or import_ss, respectively, are excluded from using this function, as no colony list was returned.

For other users, it is necessary that a colony list was imported with import_json. In other case, no colony list exists and this function cannot be used.

Nodes represent the colony instants of the movie and are colored based on the ID of the corresponding colony. The imaginary root colony instant is colored white. Gray nodes are colony instants which have arised from merged colonies.


vicstefanou/ViSCA documentation built on May 31, 2019, 10:50 p.m.