get_parent_id: Generic for Getting Parent Node Id.

get_parent_idR Documentation

Generic for Getting Parent Node Id.

Description

The generic method definition for getting parent node id.

Usage

get_parent_id(x, node_num)

## S4 method for signature 'TreeHarp'
get_parent_id(x, node_num)

## S4 method for signature 'list'
get_parent_id(x, node_num)

Arguments

x

An object of class TreeHarp or an adjacency list.

node_num

An integer, length 1. This the node whose parent we are after. If node_num is equal to 1, then NULL is returned because that should be the root node.

Value

An integer, indicating the parent node.

Methods (by class)

  • get_parent_id(TreeHarp): Obtain parent node id.

    Extracts parent id of a node from a TreeHarp object.

  • get_parent_id(list): Obtain parent node id.

    Extracts parent id of a node from an adjacency list object.

See Also

get_child_ids


autoharp documentation built on April 3, 2025, 6:36 p.m.