remove_famg: Remove a Family group record from a tidyged object

View source: R/family_group.R

remove_famgR Documentation

Remove a Family group record from a tidyged object

Description

This function removes a record containing details of a family group.

Usage

remove_famg(gedcom, family_xref = character(), remove_individuals = FALSE)

Arguments

gedcom

A tidyged object.

family_xref

The xref of a Family Group record to act on if one is not activated (will override active record).

remove_individuals

Whether to also remove the records for all Individuals in the family.

Details

This function will also automatically remove references to this record in other individual records. If remove_individuals is set to TRUE, it will also remove all records for individuals in this family (including associations).

Value

An updated tidyged object excluding the selected Family group record (and potentially the individuals within it).


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