get_attr_stats: Get statistic of an attribute

Description Usage Arguments Details Value

Description

Returns the statistic of a numeric attribute of a lineage or division tree.

Usage

1
2
get_attr_stats(tree, treeT = c("LT", "DT"), attr, stat = c("mean", "median",
  "sd", "min", "max"))

Arguments

tree

The lineage or division tree, an object of class "igraph".

treeT

A character string naming the type of tree:

  • "LT" if tree is a lineage tree

  • "DT" if tree is a division tree

attr

The name of the attribute in the tree, a character string. It can be any numeric attribute, as returned from get_attr_names, except for "colony", "generation" and "frame".

stat

A character string naming the statistic to be returned:

  • "mean" for the mean

  • "median" for the median

  • "sd" for the standard deviation

  • "min" for the minimum value

  • "max" for the maximum value

Details

The statistic is calculated considering all cells that are included in the analysis, as returned from get_cells, except for cells with NA value in attr.

Value

A named list with the following components:

Ncells

Number of cells, a positive integer value.

value

The corresponding statistic of attribute attr, a numeric value, or NA.


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