get_descendants: Identify all descendants for an individual

In jl5000/tidygedcom: Handle GEDCOM Files Using Tidyverse Principles

Identify all descendants for an individual

Description

This function identifies records in an entire branch of the family tree below a certain individual.

Usage

get_descendants(
  gedcom,
  indi_xref = character(),
  inc_indi = FALSE,
  inc_part = FALSE,
  inc_famg = FALSE,
  inc_supp = FALSE,
  birth_only = TRUE
)

Arguments

gedcom	A tidyged object.
indi_xref	The xref of an Individual record to act on if one is not activated (will override active record).
inc_indi	Whether to also include the individual themselves.
inc_part	Whether to also include all partners of this individual (and their descendants and descendants' partners).
inc_famg	Whether to also include all Family Group records where this individual is a partner (and all descendants' Family Group records).
inc_supp	Whether to also include all supporting records (Note, Source, Repository, Multimedia).
birth_only	Whether to only include biological descendants.

Value

A vector of xrefs of descendants.

jl5000/tidygedcom documentation built on June 22, 2022, 5:16 p.m.