segChildrenAll: All children of segment

Description Usage Arguments

View source: R/tree-navigate.R

Description

Returns the segment ids of all segments that are children (and grandchildren and great-grandchildren...) of a parent segment specified.

Usage

1
2
3
4
5
6
7
segChildrenAll(
  object,
  segment,
  include.self = F,
  original.joins = F,
  format = c("unary", "binary")
)

Arguments

object

An URD object

segment

(Character) Name of segment to start from

include.self

(Logical) Should segment be included in the list of children?

original.joins

(Logical) Should children be drawn from @tree$segment.joins (FALSE) or @tree$segment.joins.initial (TRUE)? (@tree$segment.joins.initial reflects the process of constructing the tree and includes all initial starting tips. @tree$segment.joins reflects the final structure of the tree, after segments have been removed due to insufficient members or pseudotime length.)

format

(Character: "unary" or "binary") Reflects the storage structure of @tree$segment.joins. binary is only used internally, and all user queries should be unary.


farrellja/URD documentation built on June 17, 2020, 4:48 a.m.