describe_famg: Get a description of a record

In jl5000/tidygedcom: Handle GEDCOM Files Using Tidyverse Principles

Get a description of a record

Description

Get descriptions of a record at various degrees of detail.

Usage

describe_famg(gedcom, xref, short_desc = FALSE)

describe_indi(gedcom, xref, name_only = FALSE, short_desc = FALSE)

describe_media(gedcom, xref, file_ref_only = FALSE, short_desc = FALSE)

describe_sour(gedcom, xref, title_only = FALSE, short_desc = FALSE)

describe_repo(gedcom, xref, name_only = FALSE, short_desc = FALSE)

describe_note(gedcom, xref, short_desc = FALSE)

describe_subm(gedcom, xref, name_only = FALSE, short_desc = FALSE)

Arguments

gedcom	A tidyged object.
xref	An xref of a record.
short_desc	Whether to return a shorter description.
name_only	Whether to return the individual/repository name only. If none is found, the xref is returned.
file_ref_only	Whether to return the multimedia file reference only. If none is found, the xref is returned.
title_only	Whether to return the source title only. If none is found, the xref is returned.

Details

This function offers three levels of detail. For example, individual records can be:

"Joe Bloggs" (name_only = TRUE) "Individual @I1@, Joe Bloggs" (short_desc = TRUE) "Individual @I1@, Joe Bloggs, child of X and Y, born on x/x/x in place, died on x/x/x in place" (short_desc = FALSE)

Value

A character string describing the record.

Examples

describe_famg(sample555, "@F1@")
describe_famg(sample555, "@F1@", short_desc  = TRUE)
describe_indi(sample555, "@I1@")
describe_indi(sample555, "@I1@", short_desc = TRUE)
describe_indi(sample555, "@I1@", name_only = TRUE)

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