Get descriptions of a record at various degrees of detail.
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)A tidyged object.
An xref of a record.
Whether to return a shorter description.
Whether to return the individual/repository name only. If none is found, the xref is returned.
Whether to return the multimedia file reference only. If none is found, the xref is returned.
Whether to return the source title only. If none is found, the xref is returned.
A character string describing the record.
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)
describe_famg(sample555, "@F1@")
#> [1] "Family @F1@, headed by Robert Eugene Williams and Mary Ann Wilson, and children: Joe Williams"
describe_famg(sample555, "@F1@", short_desc = TRUE)
#> [1] "Family @F1@, headed by Robert Eugene Williams and Mary Ann Wilson"
describe_indi(sample555, "@I1@")
#> [1] "Individual @I1@, Robert Eugene Williams, born 2 OCT 1822 in Weston, Madison, Connecticut, United States of America, died 14 APR 1905 in Stamford, Fairfield, Connecticut, United States of America"
describe_indi(sample555, "@I1@", short_desc = TRUE)
#> [1] "Individual @I1@, Robert Eugene Williams"
describe_indi(sample555, "@I1@", name_only = TRUE)
#> [1] "Robert Eugene Williams"