add_famg: Add a Family Group record to a tidyged object

In jl5000/tidygedcom: Handle GEDCOM Files Using Tidyverse Principles

Add a Family Group record to a tidyged object

Description

Add a Family Group record to a tidyged object

Usage

add_famg(
  gedcom,
  husband = character(),
  wife = character(),
  children = character(),
  number_of_children = character(),
  user_reference_numbers = character(),
  family_notes = character(),
  multimedia_links = character()
)

Arguments

gedcom	A tidyged object.
husband	An xref identifying the husband of this family.
wife	An xref identifying the wife of this family.
children	A character vector of xrefs identifying the children of this family. These are assumed to be biological children ("birth"). If non-biological children are to be defined, use a named vector to define the relationships using a name of either "adopted" or "foster". For example: children = c("@I4@", adopted = "@I7@", adopted = "@I10@") defines a single biological child and two adopted children.
number_of_children	The reported number of children known to belong to this family, regardless of whether the associated children are represented here.
user_reference_numbers	A unique user-defined number or text that the submitter uses to identify this record. You can supply more than one in a vector. You can also define a user reference type by using a named vector (e.g c(id1 = "123A", id2 = "456B")).
family_notes	A character vector of notes accompanying this Family group record. These could be xrefs to existing Note records.
multimedia_links	A character vector of Multimedia record xrefs accompanying this record.

Details

If you need to add further information about this family (i.e. events), use the add_famg_event() function.

The function will automatically add links to this family to the respective Individual records of the wife, husband, and children.

Value

An updated tidyged object including the Family group record.

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