Title: | Internal Data Structures for the 'Tidyged' Package |
---|---|
Description: | Represent data structures described in the GEDCOM 5.5.5 Specification as tidy data. |
Authors: | Jamie Lendrum [aut, cre] |
Maintainer: | Jamie Lendrum <[email protected]> |
License: | GPL (>= 2) |
Version: | 1.5.0.9000 |
Built: | 2024-11-04 02:47:24 UTC |
Source: | https://github.com/jl5000/tidyged.internals |
Push a tidyged structure down a number of levels
add_levels(df, start_level)
add_levels(df, start_level)
df |
A tidyged structure. |
start_level |
How many levels to add on to the existing levels. |
The tidyged structure with modified levels.
This function constructs a tibble representation of the ADDRESS_STRUCTURE from the GEDCOM 5.5.5 specification.
ADDRESS_STRUCTURE( local_address_lines = character(), address_city = character(), address_state = character(), address_postal_code = character(), address_country = character(), phone_number = character(), address_email = character(), address_fax = character(), address_web_page = character() )
ADDRESS_STRUCTURE( local_address_lines = character(), address_city = character(), address_state = character(), address_postal_code = character(), address_country = character(), phone_number = character(), address_email = character(), address_fax = character(), address_web_page = character() )
local_address_lines |
The local address lines before the town/city. This can be a vector with up to 3 elements. |
address_city |
The name of the city/town used in the address. |
address_state |
The name of the province, state or similar country subdivision used in the address. |
address_postal_code |
The ZIP or postal code used by the various localities in handling of mail. |
address_country |
The name of the country that pertains to the associated address. |
phone_number |
A phone number. |
address_email |
An electronic address that can be used for contact such as an email address. |
address_fax |
A FAX telephone number appropriate for sending data facsimiles. |
address_web_page |
The world wide web page address. |
A tidy tibble containing the ADDRESS_STRUCTURE part of a GEDCOM file.
This function is used to assign xrefs to new records that are created.
assign_xref_indi(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_famg(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_sour(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_repo(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_media(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_note(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_subm(gedcom = empty_gedcom(), ref = 0, quantity = 1)
assign_xref_indi(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_famg(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_sour(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_repo(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_media(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_note(gedcom = empty_gedcom(), ref = 0, quantity = 1) assign_xref_subm(gedcom = empty_gedcom(), ref = 0, quantity = 1)
gedcom |
A tidyged object. |
ref |
An explicit reference number if one is to be chosen manually. |
quantity |
The number of new xrefs to return. |
A vector of xrefs to use for a new record(s).
This function constructs a tibble representation of the ASSOCIATION_STRUCTURE from the GEDCOM 5.5.5 specification.
ASSOCIATION_STRUCTURE( xref_indi, relation_is_descriptor, source_citations = list(), notes = list() )
ASSOCIATION_STRUCTURE( xref_indi, relation_is_descriptor, source_citations = list(), notes = list() )
xref_indi |
An xref ID of an Individual record. |
relation_is_descriptor |
A word or phrase that states object 1's relation is object 2. |
source_citations |
A list of SOURCE_CITATION() objects. |
notes |
A list of NOTE_STRUCTURE() objects. |
A tidy tibble containing the ASSOCIATION_STRUCTURE part of a GEDCOM file.
This function constructs a tibble representation of the CHANGE_DATE from the GEDCOM 5.5.5 specification.
CHANGE_DATE( change_date = date_exact(), time_value = character(), notes = list() )
CHANGE_DATE( change_date = date_exact(), time_value = character(), notes = list() )
change_date |
A date_exact() object giving the date that this data was changed. |
time_value |
The time of a specific event. |
notes |
A list of NOTE_STRUCTURE() objects. |
A tidy tibble containing the CHANGE_DATE part of a GEDCOM file.
This function constructs a tibble representation of the CHILD_TO_FAMILY_LINK from the GEDCOM 5.5.5 specification.
CHILD_TO_FAMILY_LINK( xref_fam, pedigree_linkage_type = character(), notes = list() )
CHILD_TO_FAMILY_LINK( xref_fam, pedigree_linkage_type = character(), notes = list() )
xref_fam |
An xref ID of a Family Group record. |
pedigree_linkage_type |
A code used to indicate the child to family relationship for pedigree navigation purposes. One of "birth", "adopted", "foster". |
notes |
A list of NOTE_STRUCTURE() objects. |
A tidy tibble containing the CHILD_TO_FAMILY_LINK part of a GEDCOM file.
These functions check values for length, character limit, and form.
chk_address_city(input, max_dim) chk_address_country(input, max_dim) chk_address_email(input, max_dim) chk_address_fax(input, max_dim) chk_address_lines(input, max_dim) chk_address_postal_code(input, max_dim) chk_address_state(input, max_dim) chk_address_web_page(input, max_dim) chk_address_country(input, max_dim) chk_adopted_by_which_parent(input, max_dim) chk_age_at_event(input, max_dim) chk_attribute_descriptor(input, max_dim) chk_attribute_type(input, max_dim) chk_automated_record_id(input, max_dim) chk_before_common_era(input, max_dim) chk_caste_name(input, max_dim) chk_cause_of_event(input, max_dim) chk_certainty_assessment(input, max_dim) chk_character_encoding(input, max_dim) chk_copyright_gedcom_file(input, max_dim) chk_copyright_source_data(input, max_dim) chk_count_of_children(input, max_dim) chk_date_exact(input, max_dim) chk_date_period_covered(input, max_dim) chk_date_value(input, max_dim) chk_descriptive_title(input, max_dim) chk_event_descriptor(input, max_dim) chk_event_or_fact_classification(input, max_dim) chk_event_type_cited_from(input, max_dim) chk_event_type_family(input, max_dim) chk_event_type_individual(input, max_dim) chk_events_recorded(input, max_dim) chk_gedcom_content_description(input, max_dim) chk_gedcom_file_name(input, max_dim) chk_gedcom_form(input, max_dim) chk_gedcom_version_number(input, max_dim) chk_id_number(input, max_dim) chk_language_of_text(input, max_dim) chk_multimedia_file_reference(input, max_dim) chk_multimedia_format(input, max_dim) chk_name_of_business(input, max_dim) chk_name_of_product(input, max_dim) chk_name_of_repository(input, max_dim) chk_name_of_source_data(input, max_dim) chk_name_personal(input, max_dim) chk_name_phonetic(input, max_dim) chk_name_piece_given(input, max_dim) chk_name_piece_nickname(input, max_dim) chk_name_piece_prefix(input, max_dim) chk_name_piece_suffix(input, max_dim) chk_name_piece_surname(input, max_dim) chk_name_piece_surname_prefix(input, max_dim) chk_name_romanised(input, max_dim) chk_name_type(input, max_dim) chk_national_or_tribal_origin(input, max_dim) chk_nobility_type_title(input, max_dim) chk_number_of_relationships(input, max_dim) chk_occupation(input, max_dim) chk_pedigree_linkage_type(input, max_dim) chk_phone_number(input, max_dim) chk_phonetisation_method(input, max_dim) chk_physical_description(input, max_dim) chk_place_latitude(input, max_dim) chk_place_longitude(input, max_dim) chk_place_name(input, max_dim) chk_place_phonetic(input, max_dim) chk_place_romanised(input, max_dim) chk_possessions(input, max_dim) chk_product_version_number(input, max_dim) chk_receiving_system_name(input, max_dim) chk_relation_is_descriptor(input, max_dim) chk_religious_affiliation(input, max_dim) chk_responsible_agency(input, max_dim) chk_role_in_event(input, max_dim) chk_romanisation_method(input, max_dim) chk_scholastic_achievement(input, max_dim) chk_sex_value(input, max_dim) chk_source_call_number(input, max_dim) chk_source_descriptive_title(input, max_dim) chk_source_filed_by_entry(input, max_dim) chk_source_jurisdiction_place(input, max_dim) chk_source_media_type(input, max_dim) chk_source_originator(input, max_dim) chk_source_publication_facts(input, max_dim) chk_submitter_name(input, max_dim) chk_system_id(input, max_dim) chk_text_from_source(input, max_dim) chk_time_value(input, max_dim) chk_user_reference_number(input, max_dim) chk_user_reference_type(input, max_dim) chk_user_text(input, max_dim) chk_where_within_source(input, max_dim) chk_xref(input, max_dim)
chk_address_city(input, max_dim) chk_address_country(input, max_dim) chk_address_email(input, max_dim) chk_address_fax(input, max_dim) chk_address_lines(input, max_dim) chk_address_postal_code(input, max_dim) chk_address_state(input, max_dim) chk_address_web_page(input, max_dim) chk_address_country(input, max_dim) chk_adopted_by_which_parent(input, max_dim) chk_age_at_event(input, max_dim) chk_attribute_descriptor(input, max_dim) chk_attribute_type(input, max_dim) chk_automated_record_id(input, max_dim) chk_before_common_era(input, max_dim) chk_caste_name(input, max_dim) chk_cause_of_event(input, max_dim) chk_certainty_assessment(input, max_dim) chk_character_encoding(input, max_dim) chk_copyright_gedcom_file(input, max_dim) chk_copyright_source_data(input, max_dim) chk_count_of_children(input, max_dim) chk_date_exact(input, max_dim) chk_date_period_covered(input, max_dim) chk_date_value(input, max_dim) chk_descriptive_title(input, max_dim) chk_event_descriptor(input, max_dim) chk_event_or_fact_classification(input, max_dim) chk_event_type_cited_from(input, max_dim) chk_event_type_family(input, max_dim) chk_event_type_individual(input, max_dim) chk_events_recorded(input, max_dim) chk_gedcom_content_description(input, max_dim) chk_gedcom_file_name(input, max_dim) chk_gedcom_form(input, max_dim) chk_gedcom_version_number(input, max_dim) chk_id_number(input, max_dim) chk_language_of_text(input, max_dim) chk_multimedia_file_reference(input, max_dim) chk_multimedia_format(input, max_dim) chk_name_of_business(input, max_dim) chk_name_of_product(input, max_dim) chk_name_of_repository(input, max_dim) chk_name_of_source_data(input, max_dim) chk_name_personal(input, max_dim) chk_name_phonetic(input, max_dim) chk_name_piece_given(input, max_dim) chk_name_piece_nickname(input, max_dim) chk_name_piece_prefix(input, max_dim) chk_name_piece_suffix(input, max_dim) chk_name_piece_surname(input, max_dim) chk_name_piece_surname_prefix(input, max_dim) chk_name_romanised(input, max_dim) chk_name_type(input, max_dim) chk_national_or_tribal_origin(input, max_dim) chk_nobility_type_title(input, max_dim) chk_number_of_relationships(input, max_dim) chk_occupation(input, max_dim) chk_pedigree_linkage_type(input, max_dim) chk_phone_number(input, max_dim) chk_phonetisation_method(input, max_dim) chk_physical_description(input, max_dim) chk_place_latitude(input, max_dim) chk_place_longitude(input, max_dim) chk_place_name(input, max_dim) chk_place_phonetic(input, max_dim) chk_place_romanised(input, max_dim) chk_possessions(input, max_dim) chk_product_version_number(input, max_dim) chk_receiving_system_name(input, max_dim) chk_relation_is_descriptor(input, max_dim) chk_religious_affiliation(input, max_dim) chk_responsible_agency(input, max_dim) chk_role_in_event(input, max_dim) chk_romanisation_method(input, max_dim) chk_scholastic_achievement(input, max_dim) chk_sex_value(input, max_dim) chk_source_call_number(input, max_dim) chk_source_descriptive_title(input, max_dim) chk_source_filed_by_entry(input, max_dim) chk_source_jurisdiction_place(input, max_dim) chk_source_media_type(input, max_dim) chk_source_originator(input, max_dim) chk_source_publication_facts(input, max_dim) chk_submitter_name(input, max_dim) chk_system_id(input, max_dim) chk_text_from_source(input, max_dim) chk_time_value(input, max_dim) chk_user_reference_number(input, max_dim) chk_user_reference_type(input, max_dim) chk_user_text(input, max_dim) chk_where_within_source(input, max_dim) chk_xref(input, max_dim)
input |
An input value. |
max_dim |
The maximum length of the input value. |
The functions are designed to be combined with the parse_error function, but are also used for input validation in the shinyged package.
Either a single character string describing the first error encountered, or NULL if no errors are found.
Check one date_calendar() object occurs after another
chk_dates(start_date, end_date)
chk_dates(start_date, end_date)
start_date |
A date_calendar() string for the earlier date. |
end_date |
A date_calendar() string for the later date. |
Either a single character string describing the error encountered, or NULL if no errors are found.
This function constructs a full personal name from individual name pieces.
construct_full_name( prefix = character(), given = character(), surname_prefix = character(), surname = character(), suffix = character() )
construct_full_name( prefix = character(), given = character(), surname_prefix = character(), surname = character(), suffix = character() )
prefix |
The name prefix. |
given |
The given name(s). |
surname_prefix |
The surname prefix. |
surname |
The surname. |
suffix |
The name suffix. |
The full name with all name pieces combined.
Construct a DATE_APPROXIMATED string
date_approximated( date = date_calendar(), about = TRUE, calc = FALSE, est = FALSE )
date_approximated( date = date_calendar(), about = TRUE, calc = FALSE, est = FALSE )
date |
A DATE_CALENDAR() object giving the uncertain date. |
about |
Whether the date is approximate. |
calc |
Whether the date is calculated from other values. |
est |
Whether the date is estimated. |
A DATE_APPROXIMATED string.
Construct a DATE_CALENDAR string
date_calendar( year = integer(), month = integer(), day = integer(), year_is_bce = FALSE, year_is_dual = FALSE )
date_calendar( year = integer(), month = integer(), day = integer(), year_is_bce = FALSE, year_is_dual = FALSE )
year |
The year. |
month |
The month number. |
day |
The day number. |
year_is_bce |
If the year is given without a day or month, whether it should be interpreted as being before the Common Era. |
year_is_dual |
If the year is given with a month, whether to interpret the year as the first part of a dual year (only for English dates pre-1752). If TRUE, it will transform a year of 1745 to 1745/46. |
A DATE_CALENDAR string.
Return the current date in DATE_EXACT format
date_current()
date_current()
The current date in DATE_EXACT format.
Construct a DATE_EXACT string
date_exact(year = integer(), month = integer(), day = integer())
date_exact(year = integer(), month = integer(), day = integer())
year |
The year. |
month |
The month of the year. |
day |
The day of the month. |
Even though the day, month, and year are all required for an exact date, empty default values have been set so that they are represented as zero-length rows in the tidyged file (i.e. omitted).
A DATE_EXACT string
Construct a DATE_PERIOD string
date_period(start_date = date_calendar(), end_date = date_calendar())
date_period(start_date = date_calendar(), end_date = date_calendar())
start_date |
A DATE_CALENDAR() object giving the start of the period. If only the start date is provided, a string of the form "FROM date" will be returned. |
end_date |
A DATE_CALENDAR() object giving the end of the period. If only the end date is provided, a string of the form "TO date" will be returned. |
A DATE_PERIOD string.
Construct a DATE_RANGE string
date_range(start_date = date_calendar(), end_date = date_calendar())
date_range(start_date = date_calendar(), end_date = date_calendar())
start_date |
A DATE_CALENDAR() object giving the start of the range. If only the start date is provided, a string of the form "AFT date" will be returned. |
end_date |
A DATE_CALENDAR() object giving the end of the range. If only the end date is provided, a string of the form "BEF date" will be returned. |
A DATE_RANGE string.
This function constructs a tibble representation of the EVENT_DETAIL from the GEDCOM 5.5.5 specification.
EVENT_DETAIL( event_or_fact_classification = character(), date = character(), place = PLACE_STRUCTURE(character()), address = ADDRESS_STRUCTURE(), responsible_agency = character(), religious_affiliation = character(), cause_of_event = character(), notes = list(), source_citations = list(), multimedia_links = list() )
EVENT_DETAIL( event_or_fact_classification = character(), date = character(), place = PLACE_STRUCTURE(character()), address = ADDRESS_STRUCTURE(), responsible_agency = character(), religious_affiliation = character(), cause_of_event = character(), notes = list(), source_citations = list(), multimedia_links = list() )
event_or_fact_classification |
A descriptive word or phrase used to further classify the parent event or attribute tag. This should be used whenever either of the generic EVEN or FACT tags are used. The value of this primitive is responsible for classifying the generic event or fact being cited. |
date |
A date_calendar(), date_period(), date_range(), or date_approximated() value giving the timing of the event. |
place |
A PLACE_STRUCTURE() object giving the location of the event. |
address |
An ADDRESS_STRUCTURE() object giving the address of the event. |
responsible_agency |
The organization, institution, corporation, person, or other entity that has responsibility for the associated context. For example, an employer of a person of an associated occupation, or a church that administered rites or events, or an organization responsible for creating and/or archiving records. |
religious_affiliation |
A name of the religion with which this person, event, or record was affiliated. |
cause_of_event |
Used in special cases to record the reasons which precipitated an event. Normally this will be used subordinate to a death event to show cause of death, such as might be listed on a death certificate. |
notes |
A list of NOTE_STRUCTURE() objects. |
source_citations |
A list of SOURCE_CITATION() objects. |
multimedia_links |
A list of MULTIMEDIA_LINK() objects |
A tidy tibble containing the EVENT_DETAIL part of a GEDCOM file.
This function constructs a tibble representation of the FAMILY_EVENT_DETAIL from the GEDCOM 5.5.5 specification.
FAMILY_EVENT_DETAIL( husband_age_at_event = character(), wife_age_at_event = character(), event_details = EVENT_DETAIL() )
FAMILY_EVENT_DETAIL( husband_age_at_event = character(), wife_age_at_event = character(), event_details = EVENT_DETAIL() )
husband_age_at_event |
A string that indicates the age in years, months, and days that the husband was at the time of the associated event. See Details. |
wife_age_at_event |
A string that indicates the age in years, months, and days that the wife was at the time of the associated event. See Details. |
event_details |
An EVENT_DETAIL() object giving details of the event. |
For ages, any labels must come after their corresponding number, for example; 4y 8m 10d. The line value should be normalised; it should for example not specify 2y 13m, but 3y 1m instead. Number of days is allowed to be 365 because of leap years. The YYY, MM and DDD values must not be zero; if a value equals zero, that part is left off. The values may not contain leading zeroes either.
A tidy tibble containing the FAMILY_EVENT_DETAIL part of a GEDCOM file.
This function constructs a tibble representation of the FAMILY_EVENT_STRUCTURE from the GEDCOM 5.5.5 specification.
FAMILY_EVENT_STRUCTURE( event_type_family, event_descriptor = "", family_event_details = FAMILY_EVENT_DETAIL() )
FAMILY_EVENT_STRUCTURE( event_type_family, event_descriptor = "", family_event_details = FAMILY_EVENT_DETAIL() )
event_type_family |
A code used to indicate the type of family event. One of: "ANUL", "CENS", "DIV", "DIVF", "ENGA", "MARB", "MARC", "MARR", "MARL", "MARS", "RESI", "EVEN". |
event_descriptor |
Text describing a particular event pertaining to the individual or family. This event value is usually assigned to the EVEN tag. The classification as to the difference between this specific event and other occurrences of the EVENt tag is indicated by the use of a subordinate TYPE tag selected from the EVENT_DETAIL structure. |
family_event_details |
A FAMILY_EVENT_DETAIL() object giving details of the event. |
A tidy tibble containing the FAMILY_EVENT_STRUCTURE part of a GEDCOM file.
This function constructs a tibble representation of the FAMILY_GROUP_RECORD from the GEDCOM 5.5.5 specification.
FAMILY_GROUP_RECORD( xref_fam, events = list(), xref_husb = character(), xref_wife = character(), xrefs_chil = character(), count_of_children = character(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE(), notes = list(), source_citations = list(), multimedia_links = list() )
FAMILY_GROUP_RECORD( xref_fam, events = list(), xref_husb = character(), xref_wife = character(), xrefs_chil = character(), count_of_children = character(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE(), notes = list(), source_citations = list(), multimedia_links = list() )
xref_fam |
An xref ID of a Family Group record. |
events |
A list of FAMILY_EVENT_STRUCTURE() objects giving events associated with this family. |
xref_husb |
An xref ID of the husband. |
xref_wife |
An xref ID of the wife. |
xrefs_chil |
A vector of xref IDs of children in this family. |
count_of_children |
The known number of children of this individual from all marriages or, if subordinate to a family group record, the reported number of children known to belong to this family, regardless of whether the associated children are represented in the corresponding structure. This is not necessarily the count of children listed in a family structure. |
user_reference_number |
A user-defined number or text that the submitter uses to identify this record. |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
notes |
A list of NOTE_STRUCTURE() objects. |
source_citations |
A list of SOURCE_CITATION() objects. |
multimedia_links |
A list of MULTIMEDIA_LINK() objects |
A tidy tibble containing a FAMILY_GROUP_RECORD part of a GEDCOM file.
Finalise the formation of a tidyged record
finalise(df, global_start_level = 0)
finalise(df, global_start_level = 0)
df |
A tidyged record tibble. |
global_start_level |
A global start level for records (default is 0). |
A final tidyged record tibble.
This is for inserting rows at the end of a record or subrecord.
find_insertion_point( gedcom, xref, parent_level, parent_tag, parent_value = NULL )
find_insertion_point( gedcom, xref, parent_level, parent_tag, parent_value = NULL )
gedcom |
A tidyged object. |
xref |
The xref of the record where the insertion point will be. |
parent_level |
The level of the row where the insertion point will be. |
parent_tag |
The tag of the row where the insertion point will be. |
parent_value |
The value of the row where the insertion point will be. |
The row after the insertion point in the tidyged object.
This function constructs a tibble representation of the FOOTER_SECTION from the GEDCOM 5.5.5 specification.
FOOTER_SECTION()
FOOTER_SECTION()
A tidy tibble containing a FOOTER_SECTION part of a GEDCOM file.
This function constructs a tibble representation of the GEDCOM_HEADER from the GEDCOM 5.5.5 specification.
GEDCOM_HEADER( character_encoding = "UTF-8", gedcom_version_number = "5.5.5", gedcom_form = "LINEAGE-LINKED", header_extension = LINEAGE_LINKED_HEADER_EXTENSION("tidyged.internals") )
GEDCOM_HEADER( character_encoding = "UTF-8", gedcom_version_number = "5.5.5", gedcom_form = "LINEAGE-LINKED", header_extension = LINEAGE_LINKED_HEADER_EXTENSION("tidyged.internals") )
character_encoding |
A code value that represents the character set and encoding to be used to interpret this data. Allowed values: "UTF-8" and "UNICODE" (UTF-16). |
gedcom_version_number |
The version number of the specification used. |
gedcom_form |
A value that identifies the GEDCOM form used in this GEDCOM file. The value must be alphanumerical string. This string is case-sensitive. Only "LINEAGE-LINKED" is supported. |
header_extension |
A LINEAGE_LINKED_HEADER_EXTENSION() object providing more information about the GEDCOM file. |
A tidy tibble containing a GEDCOM_HEADER part of a GEDCOM file.
Extract a particular value from a tidyged object
gedcom_value(gedcom, record_xref, tag, level, after_tag = NULL)
gedcom_value(gedcom, record_xref, tag, level, after_tag = NULL)
gedcom |
A tidyged object. |
record_xref |
The xref of the record in which the value may exist. |
tag |
The tag associated with the value. |
level |
The level number of the value. |
after_tag |
Whether the tag should be subordinate to this parent tag. |
The particular value fitting the criteria of the input arguments. If no value is found, an empty string is returned.
Identify the rows of subrecords in a tidyged object
identify_section( gedcom, containing_level, containing_tags, containing_values = character(), xrefs = character(), first_only = FALSE )
identify_section( gedcom, containing_level, containing_tags, containing_values = character(), xrefs = character(), first_only = FALSE )
gedcom |
A tidyged object. |
containing_level |
The level of the first line of the subrecord. |
containing_tags |
The accepted tags of the first line of the subrecord. |
containing_values |
The accepted values of the first line of the subrecord. |
xrefs |
The xrefs of records containing the subrecord (default is all records). |
first_only |
Whether to return only the first match found or to return all matches. |
A vector of rows in the tidyged object of the subrecord(s).
This function constructs a tibble representation of the INDIVIDUAL_ATTRIBUTE_STRUCTURE from the GEDCOM 5.5.5 specification.
INDIVIDUAL_ATTRIBUTE_STRUCTURE( attribute_type, attribute_descriptor, individual_event_details = INDIVIDUAL_EVENT_DETAIL() )
INDIVIDUAL_ATTRIBUTE_STRUCTURE( attribute_type, attribute_descriptor, individual_event_details = INDIVIDUAL_EVENT_DETAIL() )
attribute_type |
An attribute which may have caused name, addresses, phone numbers, family listings to be recorded. Its application is in helping to classify sources used for information. |
attribute_descriptor |
Text describing a particular characteristic or attribute assigned to an individual. |
individual_event_details |
An INDIVIDUAL_EVENT_DETAIL() object giving details of the attribute. |
A tidy tibble containing the INDIVIDUAL_ATTRIBUTE_STRUCTURE part of a GEDCOM file.
This function constructs a tibble representation of the INDIVIDUAL_EVENT_DETAIL from the GEDCOM 5.5.5 specification.
INDIVIDUAL_EVENT_DETAIL( event_details = EVENT_DETAIL(), age_at_event = character() )
INDIVIDUAL_EVENT_DETAIL( event_details = EVENT_DETAIL(), age_at_event = character() )
event_details |
An EVENT_DETAIL() object giving details of the event. |
age_at_event |
A string that indicates the age in years, months, and days that the principal was at the time of the associated event. See Details. |
For ages, any labels must come after their corresponding number, for example; 4y 8m 10d. The line value should be normalised; it should for example not specify 2y 13m, but 3y 1m instead. Number of days is allowed to be 365 because of leap years. The YYY, MM and DDD values must not be zero; if a value equals zero, that part is left off. The values may not contain leading zeroes either.
A tidy tibble containing the INDIVIDUAL_EVENT_DETAIL part of a GEDCOM file.
This function constructs a tibble representation of the INDIVIDUAL_EVENT_STRUCTURE from the GEDCOM 5.5.5 specification.
INDIVIDUAL_EVENT_STRUCTURE( event_type_individual, event_descriptor = "", individual_event_details = INDIVIDUAL_EVENT_DETAIL(), xref_fam = character(), adopted_by_which_parent = character() )
INDIVIDUAL_EVENT_STRUCTURE( event_type_individual, event_descriptor = "", individual_event_details = INDIVIDUAL_EVENT_DETAIL(), xref_fam = character(), adopted_by_which_parent = character() )
event_type_individual |
A code used to indicate the type of individual event. One of: "BIRT", "CHR", "DEAT", "BURI", "CREM", "ADOP", "BAPM", "BARM", "BASM", "CHRA", "CONF", "FCOM", "NATU", "EMIG", "IMMI", "CENS", "PROB", "WILL", "GRAD", "RETI", "EVEN". |
event_descriptor |
Text describing a particular event pertaining to the individual or family. This event value is usually assigned to the EVEN tag. The classification as to the difference between this specific event and other occurrences of the EVENt tag is indicated by the use of a subordinate TYPE tag selected from the EVENT_DETAIL structure. |
individual_event_details |
An INDIVIDUAL_EVENT_DETAIL() object giving details of the event. |
xref_fam |
An xref ID of a Family Group record. |
adopted_by_which_parent |
A code which shows which parent in the associated family group record adopted this person. Use "HUSB" for husband, "WIFE" for wife, or "BOTH" for both. |
A tidy tibble containing the INDIVIDUAL_EVENT_STRUCTURE part of a GEDCOM file.
This function constructs a tibble representation of the INDIVIDUAL_RECORD from the GEDCOM 5.5.5 specification.
INDIVIDUAL_RECORD( xref_indi, names = list(), sex_value = character(), events = list(), attributes = list(), child_to_family_links = list(), spouse_to_family_links = list(), associations = list(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE(), notes = list(), source_citations = list(), multimedia_links = list() )
INDIVIDUAL_RECORD( xref_indi, names = list(), sex_value = character(), events = list(), attributes = list(), child_to_family_links = list(), spouse_to_family_links = list(), associations = list(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE(), notes = list(), source_citations = list(), multimedia_links = list() )
xref_indi |
An xref ID of an Individual record. |
names |
A list of PERSONAL_NAME_STRUCTURE() objects giving the names associated with this individual. |
sex_value |
A code that indicates the sex of the individual. Either "M" (male), "F" (female), "U" (undetermined), "X" (intersex), or "N" (not recorded). |
events |
A list of INDIVIDUAL_EVENT_STRUCTURE() objects giving the events associated with this individual. |
attributes |
A list of INDIVIDUAL_ATTRIBUTE_STRUCTURE() objects giving the attributes associated with this individual. |
child_to_family_links |
A list of CHILD_TO_FAMILY_LINK() objects giving the details of families this individual is a child of. |
spouse_to_family_links |
A list of SPOUSE_TO_FAMILY_LINK() objects giving the details of families this individual is a spouse of. |
associations |
A list of ASSOCIATION_STRUCTURE() objects giving the details of individuals this individual is associated with. |
user_reference_number |
A user-defined number or text that the submitter uses to identify this record. |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
notes |
A list of NOTE_STRUCTURE() objects. |
source_citations |
A list of SOURCE_CITATION() objects. |
multimedia_links |
A list of MULTIMEDIA_LINK() objects |
A tidy tibble containing an INDIVIDUAL_RECORD part of a GEDCOM file.
This function constructs a tibble representation of the LINEAGE_LINKED_HEADER_EXTENSION from the GEDCOM 5.5.5 specification.
LINEAGE_LINKED_HEADER_EXTENSION( system_id, product_version_number = character(), name_of_product = character(), name_of_business = character(), business_address = ADDRESS_STRUCTURE(), name_of_source_data = character(), publication_date = date_exact(), copyright_source_data = character(), receiving_system_name = character(), file_creation_date = date_exact(), file_creation_time = character(), language_of_text = character(), xref_subm = character(), gedcom_file_name = character(), copyright_gedcom_file = character(), gedcom_content_description = character() )
LINEAGE_LINKED_HEADER_EXTENSION( system_id, product_version_number = character(), name_of_product = character(), name_of_business = character(), business_address = ADDRESS_STRUCTURE(), name_of_source_data = character(), publication_date = date_exact(), copyright_source_data = character(), receiving_system_name = character(), file_creation_date = date_exact(), file_creation_time = character(), language_of_text = character(), xref_subm = character(), gedcom_file_name = character(), copyright_gedcom_file = character(), gedcom_content_description = character() )
system_id |
A system identification name. This name must be unique for each system (product), different from any other system. The name may include spaces, and is not restricted to ASCII characters. |
product_version_number |
The version of the product that created the GEDCOM file. It is defined and changed by the creators of the product. |
name_of_product |
The name of the software product that produced this file. |
name_of_business |
Name of the business, corporation, or person that produced or commissioned the product. |
business_address |
An ADDRESS_STRUCTURE() object giving the address of the business. |
name_of_source_data |
The name of the electronic data source that was used to obtain the data in this file. For example, the data may have been obtained from a CD-ROM disc that was named "U.S. 1880 CENSUS CD-ROM vol. 13." |
publication_date |
A date_exact() object giving the date this source was published or created. |
copyright_source_data |
A copyright statement required by the owner of data from which this information was downloaded. |
receiving_system_name |
The name of the system expected to process the GEDCOM file. |
file_creation_date |
A date_exact() object giving the date that this file was created. |
file_creation_time |
The time at which the file was created. |
language_of_text |
The human language in which the data in the file is normally read or written. It is used primarily by programs to select language-specific sorting sequences and phonetic name matching algorithms. |
xref_subm |
An xref ID of a Submitter record. |
gedcom_file_name |
The name of the GEDCOM file. A GEDCOM file name should use the format basename.ext, and use the file extension .GED (or .ged). |
copyright_gedcom_file |
A copyright statement needed to protect the copyrights of the submitter of this GEDCOM file. |
gedcom_content_description |
A note that a user enters to describe the contents of the lineage-linked file in terms of "ancestors or descendants of" so that the person receiving the data knows what genealogical information the file contains. |
A tidy tibble containing the HEADER part of a GEDCOM file.
This function constructs a tibble representation of the MULTIMEDIA_LINK from the GEDCOM 5.5.5 specification.
MULTIMEDIA_LINK(xref_obje)
MULTIMEDIA_LINK(xref_obje)
xref_obje |
An xref ID of a Multimedia record. |
A tidy tibble containing the MULTIMEDIA_LINK part of a GEDCOM file.
This function constructs a tibble representation of the MULTIMEDIA_RECORD from the GEDCOM 5.5.5 specification.
MULTIMEDIA_RECORD( xref_obje, multimedia_file_reference, multimedia_format, source_media_type = character(), descriptive_title = character(), user_reference_number = character(), automated_record_id = character(), notes = list(), source_citations = list(), date_changed = CHANGE_DATE() )
MULTIMEDIA_RECORD( xref_obje, multimedia_file_reference, multimedia_format, source_media_type = character(), descriptive_title = character(), user_reference_number = character(), automated_record_id = character(), notes = list(), source_citations = list(), date_changed = CHANGE_DATE() )
xref_obje |
An xref ID of a Multimedia record. |
multimedia_file_reference |
A complete local or remote file reference to the auxiliary data to be linked to the GEDCOM context. Remote reference would include a network address where the multimedia data may be obtained. |
multimedia_format |
Indicates the format of the multimedia data associated with the specific GEDCOM context. This allows processors to determine whether they can process the data object. Any linked files should contain the data required, in the indicated format, to process the file data. One of: "AAC", "AVI", "BMP", "ePub", "FLAC", "GIF", "JPEG", "MKV", "mobi", "MP3", "PCX", "PDF", "PNG", "TIFF", "WAV". |
source_media_type |
A media classification code that indicates the type of material in which the referenced source is stored. One of: "audio", "book", "card", "electronic", "fiche", "film", "magazine", "manuscript", "map", "newspaper", "photo", "tombstone", "video". |
descriptive_title |
The title of a work, record, item, or object. |
user_reference_number |
A user-defined number or text that the submitter uses to identify this record. |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
notes |
A list of NOTE_STRUCTURE() objects. |
source_citations |
A list of SOURCE_CITATION() objects. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
A tidy tibble containing a MULTIMEDIA_RECORD part of a GEDCOM file.
This function constructs a tibble representation of the NOTE_RECORD from the GEDCOM 5.5.5 specification.
NOTE_RECORD( xref_note, user_text, user_reference_number = character(), automated_record_id = character(), source_citations = list(), date_changed = CHANGE_DATE() )
NOTE_RECORD( xref_note, user_text, user_reference_number = character(), automated_record_id = character(), source_citations = list(), date_changed = CHANGE_DATE() )
xref_note |
An xref ID of a Note record. |
user_text |
Free-form user text. Comments, opinions. |
user_reference_number |
A user-defined number or text that the submitter uses to identify this record. |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
source_citations |
A list of SOURCE_CITATION() objects. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
A tidy tibble containing a NOTE_RECORD part of a GEDCOM file.
This function constructs a tibble representation of the NOTE_STRUCTURE from the GEDCOM 5.5.5 specification.
NOTE_STRUCTURE(note = character())
NOTE_STRUCTURE(note = character())
note |
Either free-form text (comments, opinions) or an xref to another Note record. |
A tidy tibble containing the NOTE_STRUCTURE part of a GEDCOM file.
Convert a GEDCOM age at event into decimalised years
parse_gedcom_age(age_string)
parse_gedcom_age(age_string)
age_string |
A string describing an age at an event, e.g. "14y 3m 20d". |
A numeric value giving the age in years.
Convert a GEDCOM date into a lubridate date
parse_gedcom_date(date_string, minimise = TRUE)
parse_gedcom_date(date_string, minimise = TRUE)
date_string |
A date_calendar() string. |
minimise |
Whether to fill in missing date pieces so that the date is minimised. For example, if no month is given, January is used. If minimise = FALSE, December will be used. |
A lubridate date.
This function constructs a tibble representation of the PERSONAL_NAME_PIECES from the GEDCOM 5.5.5 specification.
PERSONAL_NAME_PIECES( name_piece_prefix = character(), name_piece_given = character(), name_piece_nickname = character(), name_piece_surname_prefix = character(), name_piece_surname = character(), name_piece_suffix = character(), notes = list(), source_citations = list() )
PERSONAL_NAME_PIECES( name_piece_prefix = character(), name_piece_given = character(), name_piece_nickname = character(), name_piece_surname_prefix = character(), name_piece_surname = character(), name_piece_suffix = character(), notes = list(), source_citations = list() )
name_piece_prefix |
Non indexing name piece that appears preceding the given name and surname parts. Different name prefix parts are separated by a comma. |
name_piece_given |
Given name or earned name. Different given names are separated by a comma. |
name_piece_nickname |
A descriptive or familiar name used in connection with one's proper name. |
name_piece_surname_prefix |
Surname prefix or article used in a family name. A surname prefix that consists of multiple parts is written as is, and not modified in any way. Thus, the surname prefix for the surname “de la Cruz” is “de la”. |
name_piece_surname |
Surname or family name. Different surnames are separated by a comma. |
name_piece_suffix |
Non-indexing name piece that appears after the given name and surname parts. Different name suffix parts are separated by a comma. |
notes |
A list of NOTE_STRUCTURE() objects. |
source_citations |
A list of SOURCE_CITATION() objects. |
A tidy tibble containing the PERSONAL_NAME_PIECES part of a GEDCOM file.
This function constructs a tibble representation of the PERSONAL_NAME_STRUCTURE from the GEDCOM 5.5.5 specification.
PERSONAL_NAME_STRUCTURE( name_personal, name_type = character(), name_pieces = PERSONAL_NAME_PIECES(), name_phonetic = character(), phonetisation_method = character(), phonetic_name_pieces = list(), name_romanised = character(), romanisation_method = character(), romanised_name_pieces = list() )
PERSONAL_NAME_STRUCTURE( name_personal, name_type = character(), name_pieces = PERSONAL_NAME_PIECES(), name_phonetic = character(), phonetisation_method = character(), phonetic_name_pieces = list(), name_romanised = character(), romanisation_method = character(), romanised_name_pieces = list() )
name_personal |
The full name formed in the manner the name is normally spoken. The surname of an individual, if known, is enclosed between two slash (/) characters. The order of the name parts should be the order that the person would, by custom of their culture, have used when giving it to a recorder. |
name_type |
Indicates the name type, for example the name issued or assumed as an immigrant. |
name_pieces |
A PERSONAL_NAME_PIECES() object giving the components of the name. |
name_phonetic |
A character vector of phonetic variations of the full name. |
phonetisation_method |
Indicates the method used in transforming the text to the phonetic variation. |
phonetic_name_pieces |
A list of PERSONAL_NAME_PIECES() objects giving the components of the phonetic name variations. |
name_romanised |
A character vector giving romanised variations of the name. |
romanisation_method |
Indicates the method used in transforming the text to a romanised variation. |
romanised_name_pieces |
A list of PERSONAL_NAME_PIECES() objects giving the components of the romanised name variations. |
A tidy tibble containing the PERSONAL_NAME_STRUCTURE part of a GEDCOM file.
This function constructs a tibble representation of the PLACE_STRUCTURE from the GEDCOM 5.5.5 specification.
PLACE_STRUCTURE( place_name, place_phonetic = character(), phonetisation_method = character(), place_romanised = character(), romanisation_method = character(), place_latitude = character(), place_longitude = character(), notes = list() )
PLACE_STRUCTURE( place_name, place_phonetic = character(), phonetisation_method = character(), place_romanised = character(), romanisation_method = character(), place_latitude = character(), place_longitude = character(), notes = list() )
place_name |
The jurisdictional name of the place where the event took place. Jurisdictions are separated by commas. No part of the place name may be replaced by an abbreviation. Place names are not terminated by a full stop or anything else. |
place_phonetic |
A character vector of phonetic variations of the place name. |
phonetisation_method |
Indicates the method used in transforming the text to the phonetic variation. |
place_romanised |
A character vector of romanised variations of the place name. |
romanisation_method |
Indicates the method used in transforming the text to a romanised variation. |
place_latitude |
The value specifying the latitudinal coordinate of the place name. The latitude coordinate is the direction North or South from the equator in degrees and fraction of degrees carried out to give the desired accuracy. For example: 18 degrees, 9 minutes, and 3.4 seconds North would be formatted as N18.150944. |
place_longitude |
The value specifying the longitudinal coordinate of the place name. The longitude coordinate is Degrees and fraction of degrees east or west of the zero or base meridian coordinate. For example: 168 degrees, 9 minutes, and 3.4 seconds East would be formatted as E168.150944. |
notes |
A list of NOTE_STRUCTURE() objects. |
A tidy tibble containing the PLACE_STRUCTURE part of a GEDCOM file.
Define all primitives used in GEDCOM records and subrecords.
character_encoding |
A code value that represents the character set and encoding to be used to interpret this data. Allowed values: "UTF-8" and "UNICODE" (UTF-16). |
gedcom_form |
A value that identifies the GEDCOM form used in this GEDCOM file. The value must be alphanumerical string. This string is case-sensitive. Only "LINEAGE-LINKED" is supported. |
gedcom_version_number |
The version number of the specification used. |
address_city |
The name of the city/town used in the address. |
address_country |
The name of the country that pertains to the associated address. |
address_email |
An electronic address that can be used for contact such as an email address. |
address_fax |
A FAX telephone number appropriate for sending data facsimiles. |
local_address_lines |
The local address lines before the town/city. This can be a vector with up to 3 elements. |
address_postal_code |
The ZIP or postal code used by the various localities in handling of mail. |
address_state |
The name of the province, state or similar country subdivision used in the address. |
address_web_page |
The world wide web page address. |
adopted_by_which_parent |
A code which shows which parent in the associated family group record adopted this person. Use "HUSB" for husband, "WIFE" for wife, or "BOTH" for both. |
age_at_event |
A string that indicates the age in years, months, and days that the principal was at the time of the associated event. See Details. |
husband_age_at_event |
A string that indicates the age in years, months, and days that the husband was at the time of the associated event. See Details. |
wife_age_at_event |
A string that indicates the age in years, months, and days that the wife was at the time of the associated event. See Details. |
attribute_descriptor |
Text describing a particular characteristic or attribute assigned to an individual. |
attribute_type |
An attribute which may have caused name, addresses, phone numbers, family listings to be recorded. Its application is in helping to classify sources used for information. |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
caste_name |
A name assigned to a particular group that this person was associated with, such as a particular racial group, religious group, or a group with an inherited status. |
cause_of_event |
Used in special cases to record the reasons which precipitated an event. Normally this will be used subordinate to a death event to show cause of death, such as might be listed on a death certificate. |
certainty_assessment |
A quantitative evaluation of the credibility of a piece of information, based upon its supporting evidence. Some systems use this feature to rank multiple conflicting opinions for display of most likely information first. It is not intended to eliminate the receiver's need to evaluate the evidence for themselves. 0 = unreliable/estimated data 1 = Questionable reliability of evidence 2 = Secondary evidence, data officially recorded sometime after event 3 = Direct and primary evidence used, or by dominance of the evidence |
copyright_gedcom_file |
A copyright statement needed to protect the copyrights of the submitter of this GEDCOM file. |
copyright_source_data |
A copyright statement required by the owner of data from which this information was downloaded. |
count_of_children |
The known number of children of this individual from all marriages or, if subordinate to a family group record, the reported number of children known to belong to this family, regardless of whether the associated children are represented in the corresponding structure. This is not necessarily the count of children listed in a family structure. |
descriptive_title |
The title of a work, record, item, or object. |
entry_recording_date |
A date_calendar(), date_period(), date_range(), or date_approximated() value giving the date that this event data was entered into the original source document. |
event_attribute_type |
A code that classifies the principal event or happening that caused the source record entry to be created. If the event or attribute doesn't translate to one of these tag codes, then a user supplied value is expected and will be generally classified in the category of other. |
event_descriptor |
Text describing a particular event pertaining to the individual or family. This event value is usually assigned to the EVEN tag. The classification as to the difference between this specific event and other occurrences of the EVENt tag is indicated by the use of a subordinate TYPE tag selected from the EVENT_DETAIL structure. |
event_or_fact_classification |
A descriptive word or phrase used to further classify the parent event or attribute tag. This should be used whenever either of the generic EVEN or FACT tags are used. The value of this primitive is responsible for classifying the generic event or fact being cited. |
event_type_cited_from |
A code that indicates the type of event which was responsible for the source entry being recorded. For example, if the entry was created to record a birth of a child, then the type would be BIRT regardless of the assertions made from that record, such as the mother's name or mother's birth date. This will allow a prioritised best view choice and a determination of the certainty associated with the source used in asserting the cited fact. |
event_type_family |
A code used to indicate the type of family event. One of: "ANUL", "CENS", "DIV", "DIVF", "ENGA", "MARB", "MARC", "MARR", "MARL", "MARS", "RESI", "EVEN". |
event_type_individual |
A code used to indicate the type of individual event. One of: "BIRT", "CHR", "DEAT", "BURI", "CREM", "ADOP", "BAPM", "BARM", "BASM", "CHRA", "CONF", "FCOM", "NATU", "EMIG", "IMMI", "CENS", "PROB", "WILL", "GRAD", "RETI", "EVEN". |
events_recorded |
An enumeration of the different kinds of events that were recorded in a particular source. Each enumeration is separated by a comma. Such as a parish register of births, deaths, and marriages would be BIRT, DEAT, MARR. |
file_creation_date |
A date_exact() object giving the date that this file was created. |
gedcom_content_description |
A note that a user enters to describe the contents of the lineage-linked file in terms of "ancestors or descendants of" so that the person receiving the data knows what genealogical information the file contains. |
gedcom_file_name |
The name of the GEDCOM file. A GEDCOM file name should use the format basename.ext, and use the file extension .GED (or .ged). |
id_number |
A third-party number assigned to an individual. |
language_of_text |
The human language in which the data in the file is normally read or written. It is used primarily by programs to select language-specific sorting sequences and phonetic name matching algorithms. |
multimedia_file_reference |
A complete local or remote file reference to the auxiliary data to be linked to the GEDCOM context. Remote reference would include a network address where the multimedia data may be obtained. |
multimedia_format |
Indicates the format of the multimedia data associated with the specific GEDCOM context. This allows processors to determine whether they can process the data object. Any linked files should contain the data required, in the indicated format, to process the file data. One of: "AAC", "AVI", "BMP", "ePub", "FLAC", "GIF", "JPEG", "MKV", "mobi", "MP3", "PCX", "PDF", "PNG", "TIFF", "WAV". |
name_of_business |
Name of the business, corporation, or person that produced or commissioned the product. |
name_of_product |
The name of the software product that produced this file. |
name_of_repository |
The official name of the archive in which the stated source material is stored. |
name_of_source_data |
The name of the electronic data source that was used to obtain the data in this file. For example, the data may have been obtained from a CD-ROM disc that was named "U.S. 1880 CENSUS CD-ROM vol. 13." |
name_personal |
The full name formed in the manner the name is normally spoken. The surname of an individual, if known, is enclosed between two slash (/) characters. The order of the name parts should be the order that the person would, by custom of their culture, have used when giving it to a recorder. |
name_phonetic |
A character vector of phonetic variations of the full name. |
name_piece_given |
Given name or earned name. Different given names are separated by a comma. |
name_piece_nickname |
A descriptive or familiar name used in connection with one's proper name. |
name_piece_prefix |
Non indexing name piece that appears preceding the given name and surname parts. Different name prefix parts are separated by a comma. |
name_piece_suffix |
Non-indexing name piece that appears after the given name and surname parts. Different name suffix parts are separated by a comma. |
name_piece_surname |
Surname or family name. Different surnames are separated by a comma. |
name_piece_surname_prefix |
Surname prefix or article used in a family name. A surname prefix that consists of multiple parts is written as is, and not modified in any way. Thus, the surname prefix for the surname “de la Cruz” is “de la”. |
name_romanised |
A character vector giving romanised variations of the name. |
name_type |
Indicates the name type, for example the name issued or assumed as an immigrant. |
national_or_tribal_origin |
The person's division of national origin or other folk, house, kindred, lineage, or tribal interest. |
nobility_type_title |
The title given to or used by a person, especially of royalty or other noble class within a locality. |
number_of_relationships |
The number of different relationships (family groups) that this person was known to have been a member of as a partner, regardless of whether the associated relationships are present in the GEDCOM file. |
occupation |
The kind of activity that an individual does for a job, profession, or principal activity. |
pedigree_linkage_type |
A code used to indicate the child to family relationship for pedigree navigation purposes. One of "birth", "adopted", "foster". |
phone_number |
A phone number. |
phonetisation_method |
Indicates the method used in transforming the text to the phonetic variation. |
physical_description |
An unstructured list of the attributes that describe the physical characteristics of a person, place, or object. Commas separate each attribute. For example: Hair Brown, Eyes Brown, Height 5 ft 8 in. |
place_latitude |
The value specifying the latitudinal coordinate of the place name. The latitude coordinate is the direction North or South from the equator in degrees and fraction of degrees carried out to give the desired accuracy. For example: 18 degrees, 9 minutes, and 3.4 seconds North would be formatted as N18.150944. |
place_longitude |
The value specifying the longitudinal coordinate of the place name. The longitude coordinate is Degrees and fraction of degrees east or west of the zero or base meridian coordinate. For example: 168 degrees, 9 minutes, and 3.4 seconds East would be formatted as E168.150944. |
place_name |
The jurisdictional name of the place where the event took place. Jurisdictions are separated by commas. No part of the place name may be replaced by an abbreviation. Place names are not terminated by a full stop or anything else. |
place_phonetic |
A character vector of phonetic variations of the place name. |
place_romanised |
A character vector of romanised variations of the place name. |
possessions |
A list of possessions (real estate or other property) belonging to this individual. |
product_version_number |
The version of the product that created the GEDCOM file. It is defined and changed by the creators of the product. |
publication_date |
A date_exact() object giving the date this source was published or created. |
receiving_system_name |
The name of the system expected to process the GEDCOM file. |
relation_is_descriptor |
A word or phrase that states object 1's relation is object 2. |
religious_affiliation |
A name of the religion with which this person, event, or record was affiliated. |
responsible_agency |
The organization, institution, corporation, person, or other entity that has responsibility for the associated context. For example, an employer of a person of an associated occupation, or a church that administered rites or events, or an organization responsible for creating and/or archiving records. |
role_descriptor |
A word or phrase that identifies a person's role in an event being described. This should be the same word or phrase, and in the same language, that the recorder used to define the role in the actual record. |
role_in_event |
Indicates what role this person played in the event that is being cited in this context. |
romanisation_method |
Indicates the method used in transforming the text to a romanised variation. |
scholastic_achievement |
A description of a scholastic or educational achievement or pursuit. |
sex_value |
A code that indicates the sex of the individual. Either "M" (male), "F" (female), "U" (undetermined), "X" (intersex), or "N" (not recorded). |
source_call_number |
An identification or reference description used to file and retrieve items from the holdings of a repository. |
source_descriptive_title |
The title of the work, record, or item and, when appropriate, the title of the larger work or series of which it is a part. |
source_filed_by_entry |
This entry is to provide a short title used for sorting, filing, and retrieving source records. |
source_jurisdiction_place |
The name of the lowest jurisdiction that encompasses all lower-level places named in this source. |
source_media_type |
A media classification code that indicates the type of material in which the referenced source is stored. One of: "audio", "book", "card", "electronic", "fiche", "film", "magazine", "manuscript", "map", "newspaper", "photo", "tombstone", "video". |
source_originator |
The person, agency, or entity who created the record. For a published work, this could be the author, compiler, transcriber, abstractor, or editor. For an unpublished source, this may be an individual, a government agency, church organization, or private organization, etc. |
source_publication_facts |
When and where the record was created. For published works, this includes information such as the city of publication, name of the publisher, and year of publication. |
submitter_name |
The name of the submitter formatted for display and address generation. |
system_id |
A system identification name. This name must be unique for each system (product), different from any other system. The name may include spaces, and is not restricted to ASCII characters. |
text_from_source |
A verbatim copy of any description contained within the source. This indicates notes or text that are actually contained in the source document, not the submitter's opinion about the source. |
time_value |
The time of a specific event. |
file_creation_time |
The time at which the file was created. |
user_reference_number |
A user-defined number or text that the submitter uses to identify this record. |
user_reference_type |
A user-defined definition of the user_reference_number. |
user_text |
Free-form user text. Comments, opinions. |
where_within_source |
Specific location within the information referenced. |
xref_fam |
An xref ID of a Family Group record. |
xref_indi |
An xref ID of an Individual record. |
xref_sour |
An xref ID of a Source record. |
xref_repo |
An xref ID of a Repository record. |
xref_obje |
An xref ID of a Multimedia record. |
xref_note |
An xref ID of a Note record. |
xref_subm |
An xref ID of a Submitter record. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
notes |
A list of NOTE_STRUCTURE() objects. |
source_citations |
A list of SOURCE_CITATION() objects. |
source_repository_citations |
A list of SOURCE_REPOSITORY_CITATION() objects. |
multimedia_links |
A list of MULTIMEDIA_LINK() objects |
This empty function serves as a single location where all primitives are defined, mainly for efficiency and maintainability. The first values defined are given earlier in the specification and not with the rest of the primitives.
Construct a regular expression for a custom value
reg_custom_value()
reg_custom_value()
Custom values are allowed for date values and roles in events. They are accepted for existing GEDCOM files, but they are not permitted to be created in the gedcompendium.
A regular expression pattern for a custom value.
Construct a regular expression for DATE values
reg_date(flatten = TRUE, only = TRUE)
reg_date(flatten = TRUE, only = TRUE)
flatten |
A logical value which determines whether a single regex string should be returned (flatten = TRUE) or if a vector of them should be returned (flatten = FALSE). The vector output is used if the regexes need to be combined with other regexes. If they do not, then they are anchored with ^ and $ and separated with | (OR). |
only |
Whether to allow strings of only date. If FALSE, the regular expression accepts patterns where text can come before or after the date(). |
The DATE (and subsequent DATE_CALENDAR) pattern can potentially handle several different calendar types, but this package has only implemented the Gregorian calendar.
Either a single regex string or a vector of them
Construct the regex pattern for DATE_APPROXIMATED values
reg_date_approximated(flatten = TRUE)
reg_date_approximated(flatten = TRUE)
flatten |
A logical value which determines whether a single regex string should be returned (flatten = TRUE) or if a vector of them should be returned (flatten = FALSE). The vector output is used if the regexes need to be combined with other regexes. If they do not, then they are anchored with ^ and $ and separated with | (OR). |
Either a single regex string or a vector of them
Construct a regular expression for DATE_EXACT values
reg_date_exact(only = TRUE)
reg_date_exact(only = TRUE)
only |
Whether to allow strings of only date_exact. If FALSE, the regular expression accepts patterns where text can come before or after the date_exact(). |
A regex string
Construct the regex pattern for DATE_PERIOD values
reg_date_period(flatten = TRUE)
reg_date_period(flatten = TRUE)
flatten |
A logical value which determines whether a single regex string should be returned (flatten = TRUE) or if a vector of them should be returned (flatten = FALSE). The vector output is used if the regexes need to be combined with other regexes. If they do not, then they are anchored with ^ and $ and separated with | (OR). |
Either a single regex string or a vector of them
Construct the regex pattern for DATE_RANGE values
reg_date_range(flatten = TRUE)
reg_date_range(flatten = TRUE)
flatten |
A logical value which determines whether a single regex string should be returned (flatten = TRUE) or if a vector of them should be returned (flatten = FALSE). The vector output is used if the regexes need to be combined with other regexes. If they do not, then they are anchored with ^ and $ and separated with | (OR). |
Either a single regex string or a vector of them
Construct the regex pattern for DATE_VALUE values
reg_date_value()
reg_date_value()
Either a single regex string or a vector of them
Construct a regular expression for an xref
reg_xref(only = TRUE)
reg_xref(only = TRUE)
only |
Whether to allow strings of only xrefs. If FALSE, the regular expression accepts patterns where text can come before or after the xref. |
A regular expression pattern for an xref.
Enumerate all combinations of regex patterns
regex_combn(reg1, reg2)
regex_combn(reg1, reg2)
reg1 |
A vector of regex patterns. |
reg2 |
A vector of regex patterns. |
A vector of all combinations of the concatenation of reg1 and reg2.
Remove subrecords in a tidyged object
remove_section( gedcom, containing_level, containing_tags, containing_values = character(), xrefs = character(), first_only = FALSE )
remove_section( gedcom, containing_level, containing_tags, containing_values = character(), xrefs = character(), first_only = FALSE )
gedcom |
A tidyged object. |
containing_level |
The level of the first line of the subrecord. |
containing_tags |
The accepted tags of the first line of the subrecord. |
containing_values |
The accepted values of the first line of the subrecord. |
xrefs |
The xrefs of records containing the subrecord (default is all records). |
first_only |
Whether to remove only the first match found or to remove all matches. |
The tidyged object with the subrecord(s) removed.
This function constructs a tibble representation of the REPOSITORY_RECORD from the GEDCOM 5.5.5 specification.
REPOSITORY_RECORD( xref_repo, name_of_repository, address = ADDRESS_STRUCTURE(), notes = list(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE() )
REPOSITORY_RECORD( xref_repo, name_of_repository, address = ADDRESS_STRUCTURE(), notes = list(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE() )
xref_repo |
An xref ID of a Repository record. |
name_of_repository |
The official name of the archive in which the stated source material is stored. |
address |
An ADDRESS_STRUCTURE() object giving details of the repository address. |
notes |
A list of NOTE_STRUCTURE() objects. |
user_reference_number |
A user-defined number or text that the submitter uses to identify this record. |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
A tidy tibble containing a REPOSITORY_RECORD part of a GEDCOM file.
This function sets the attribute on a dataframe identifying it as a tidyged object.
set_class_to_tidyged(gedcom)
set_class_to_tidyged(gedcom)
gedcom |
A tibble with content consistent with that of a tidyged object. |
A tidyged object.
This function constructs a tibble representation of the SOURCE_CITATION from the GEDCOM 5.5.5 specification.
SOURCE_CITATION( xref_sour, where_within_source = character(), event_type_cited_from = character(), role_in_event = character(), entry_recording_date = character(), text_from_source = character(), certainty_assessment = character(), multimedia_links = list(), notes = list() )
SOURCE_CITATION( xref_sour, where_within_source = character(), event_type_cited_from = character(), role_in_event = character(), entry_recording_date = character(), text_from_source = character(), certainty_assessment = character(), multimedia_links = list(), notes = list() )
xref_sour |
An xref ID of a Source record. |
where_within_source |
Specific location within the information referenced. |
event_type_cited_from |
A code that indicates the type of event which was responsible for the source entry being recorded. For example, if the entry was created to record a birth of a child, then the type would be BIRT regardless of the assertions made from that record, such as the mother's name or mother's birth date. This will allow a prioritised best view choice and a determination of the certainty associated with the source used in asserting the cited fact. |
role_in_event |
Indicates what role this person played in the event that is being cited in this context. |
entry_recording_date |
A date_calendar(), date_period(), date_range(), or date_approximated() value giving the date that this event data was entered into the original source document. |
text_from_source |
A verbatim copy of any description contained within the source. This indicates notes or text that are actually contained in the source document, not the submitter's opinion about the source. |
certainty_assessment |
A quantitative evaluation of the credibility of a piece of information, based upon its supporting evidence. Some systems use this feature to rank multiple conflicting opinions for display of most likely information first. It is not intended to eliminate the receiver's need to evaluate the evidence for themselves. 0 = unreliable/estimated data 1 = Questionable reliability of evidence 2 = Secondary evidence, data officially recorded sometime after event 3 = Direct and primary evidence used, or by dominance of the evidence |
multimedia_links |
A list of MULTIMEDIA_LINK() objects |
notes |
A list of NOTE_STRUCTURE() objects. |
A tidy tibble containing the SOURCE_CITATION part of a GEDCOM file.
This function constructs a tibble representation of the SOURCE_RECORD from the GEDCOM 5.5.5 specification.
SOURCE_RECORD( xref_sour, events_recorded = character(), date_period_covered = date_period(), source_jurisdiction_place = character(), responsible_agency = character(), data_notes = list(), source_originator = character(), source_descriptive_title = character(), source_filed_by_entry = character(), source_publication_facts = character(), text_from_source = character(), source_repository_citations = list(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE(), notes = list(), multimedia_links = list() )
SOURCE_RECORD( xref_sour, events_recorded = character(), date_period_covered = date_period(), source_jurisdiction_place = character(), responsible_agency = character(), data_notes = list(), source_originator = character(), source_descriptive_title = character(), source_filed_by_entry = character(), source_publication_facts = character(), text_from_source = character(), source_repository_citations = list(), user_reference_number = character(), automated_record_id = character(), date_changed = CHANGE_DATE(), notes = list(), multimedia_links = list() )
xref_sour |
An xref ID of a Source record. |
events_recorded |
An enumeration of the different kinds of events that were recorded in a particular source. Each enumeration is separated by a comma. Such as a parish register of births, deaths, and marriages would be BIRT, DEAT, MARR. |
date_period_covered |
A date_period() object associated with the period covered by the source. |
source_jurisdiction_place |
The name of the lowest jurisdiction that encompasses all lower-level places named in this source. |
responsible_agency |
The organization, institution, corporation, person, or other entity that has responsibility for the associated context. For example, an employer of a person of an associated occupation, or a church that administered rites or events, or an organization responsible for creating and/or archiving records. |
data_notes |
A list of NOTE_STRUCTURE() objects associated with the data in this source. |
source_originator |
The person, agency, or entity who created the record. For a published work, this could be the author, compiler, transcriber, abstractor, or editor. For an unpublished source, this may be an individual, a government agency, church organization, or private organization, etc. |
source_descriptive_title |
The title of the work, record, or item and, when appropriate, the title of the larger work or series of which it is a part. |
source_filed_by_entry |
This entry is to provide a short title used for sorting, filing, and retrieving source records. |
source_publication_facts |
When and where the record was created. For published works, this includes information such as the city of publication, name of the publisher, and year of publication. |
text_from_source |
A verbatim copy of any description contained within the source. This indicates notes or text that are actually contained in the source document, not the submitter's opinion about the source. |
source_repository_citations |
A list of SOURCE_REPOSITORY_CITATION() objects. |
user_reference_number |
A user-defined number or text that the submitter uses to identify this record. |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
notes |
A list of NOTE_STRUCTURE() objects. |
multimedia_links |
A list of MULTIMEDIA_LINK() objects |
A tidy tibble containing a SOURCE_RECORD part of a GEDCOM file.
This function constructs a tibble representation of the SOURCE_REPOSITORY_CITATION from the GEDCOM 5.5.5 specification.
SOURCE_REPOSITORY_CITATION(xref_repo, source_call_number = character())
SOURCE_REPOSITORY_CITATION(xref_repo, source_call_number = character())
xref_repo |
An xref ID of a Repository record. |
source_call_number |
An identification or reference description used to file and retrieve items from the holdings of a repository. |
A tidy tibble containing the SOURCE_REPOSITORY_CITATION part of a GEDCOM file.
This function constructs a tibble representation of the SPOUSE_TO_FAMILY_LINK from the GEDCOM 5.5.5 specification.
SPOUSE_TO_FAMILY_LINK(xref_fam, notes = list())
SPOUSE_TO_FAMILY_LINK(xref_fam, notes = list())
xref_fam |
An xref ID of a Family Group record. |
notes |
A list of NOTE_STRUCTURE() objects. |
A tidy tibble containing the SPOUSE_TO_FAMILY_LINK part of a GEDCOM file.
This function constructs a tibble representation of the SUBMITTER_RECORD from the GEDCOM 5.5.5 specification.
SUBMITTER_RECORD( xref_subm, submitter_name, address = ADDRESS_STRUCTURE(), multimedia_links = list(), automated_record_id = character(), notes = list(), date_changed = CHANGE_DATE() )
SUBMITTER_RECORD( xref_subm, submitter_name, address = ADDRESS_STRUCTURE(), multimedia_links = list(), automated_record_id = character(), notes = list(), date_changed = CHANGE_DATE() )
xref_subm |
An xref ID of a Submitter record. |
submitter_name |
The name of the submitter formatted for display and address generation. |
address |
An ADDRESS_STRUCTURE() object giving address details of the submitter. |
multimedia_links |
A list of MULTIMEDIA_LINK() objects |
automated_record_id |
A unique record identification number assigned to the record by the source system. This number is intended to serve as a more sure means of identification of a record for reconciling differences in data between two interfacing systems. |
notes |
A list of NOTE_STRUCTURE() objects. |
date_changed |
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used. |
A tidy tibble containing a SUBMITTER_RECORD part of a GEDCOM file.
These functions return the valid values that are allowed by the GEDCOM Specification.
val_languages() val_sexes() val_multimedia_formats() val_pedigree_linkage_types() val_source_media_types() val_adoptive_parents() val_roles() val_attribute_types() val_family_event_types() val_individual_event_types()
val_languages() val_sexes() val_multimedia_formats() val_pedigree_linkage_types() val_source_media_types() val_adoptive_parents() val_roles() val_attribute_types() val_family_event_types() val_individual_event_types()
A character vector of valid values.