R/docs_primitives.R
primitive_definitions.RdDefine all primitives used in GEDCOM records and subrecords.
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).
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.
The version number of the specification used.
The name of the city/town used in the address.
The name of the country that pertains to the associated address.
An electronic address that can be used for contact such as an email address.
A FAX telephone number appropriate for sending data facsimiles.
The local address lines before the town/city. This can be a vector with up to 3 elements.
The ZIP or postal code used by the various localities in handling of mail.
The name of the province, state or similar country subdivision used in the address.
The world wide web page address.
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 string that indicates the age in years, months, and days that the principal was at the time of the associated event. See Details.
A string that indicates the age in years, months, and days that the husband was at the time of the associated event. See Details.
A string that indicates the age in years, months, and days that the wife was at the time of the associated event. See Details.
Text describing a particular characteristic or attribute assigned to an individual.
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.
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.
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.
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.
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
A copyright statement needed to protect the copyrights of the submitter of this GEDCOM file.
A copyright statement required by the owner of data from which this information was downloaded.
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.
The title of a work, record, item, or object.
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.
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.
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.
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.
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.
A code used to indicate the type of family event. One of: "ANUL", "CENS", "DIV", "DIVF", "ENGA", "MARB", "MARC", "MARR", "MARL", "MARS", "RESI", "EVEN".
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".
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.
A date_exact() object giving the date that this file was created.
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.
The name of the GEDCOM file. A GEDCOM file name should use the format basename.ext, and use the file extension .GED (or .ged).
A third-party number assigned to an individual.
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.
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.
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 the business, corporation, or person that produced or commissioned the product.
The name of the software product that produced this file.
The official name of the archive in which the stated source material is stored.
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."
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.
A character vector of phonetic variations of the full name.
Given name or earned name. Different given names are separated by a comma.
A descriptive or familiar name used in connection with one's proper name.
Non indexing name piece that appears preceding the given name and surname parts. Different name prefix parts are separated by a comma.
Non-indexing name piece that appears after the given name and surname parts. Different name suffix parts are separated by a comma.
Surname or family name. Different surnames are separated by a comma.
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”.
A character vector giving romanised variations of the name.
Indicates the name type, for example the name issued or assumed as an immigrant.
The person's division of national origin or other folk, house, kindred, lineage, or tribal interest.
The title given to or used by a person, especially of royalty or other noble class within a locality.
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.
The kind of activity that an individual does for a job, profession, or principal activity.
A code used to indicate the child to family relationship for pedigree navigation purposes. One of "birth", "adopted", "foster".
A phone number.
Indicates the method used in transforming the text to the phonetic variation.
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.
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.
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.
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.
A character vector of phonetic variations of the place name.
A character vector of romanised variations of the place name.
A list of possessions (real estate or other property) belonging to this individual.
The version of the product that created the GEDCOM file. It is defined and changed by the creators of the product.
A date_exact() object giving the date this source was published or created.
The name of the system expected to process the GEDCOM file.
A word or phrase that states object 1's relation is object 2.
A name of the religion with which this person, event, or record was affiliated.
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.
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.
Indicates what role this person played in the event that is being cited in this context.
Indicates the method used in transforming the text to a romanised variation.
A description of a scholastic or educational achievement or pursuit.
A code that indicates the sex of the individual. Either "M" (male), "F" (female), "U" (undetermined), "X" (intersex), or "N" (not recorded).
An identification or reference description used to file and retrieve items from the holdings of a repository.
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.
This entry is to provide a short title used for sorting, filing, and retrieving source records.
The name of the lowest jurisdiction that encompasses all lower-level places named in this source.
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".
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.
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.
The name of the submitter formatted for display and address generation.
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.
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.
The time of a specific event.
The time at which the file was created.
A user-defined number or text that the submitter uses to identify this record.
A user-defined definition of the user_reference_number.
Free-form user text. Comments, opinions.
Specific location within the information referenced.
An xref ID of a Family Group record.
An xref ID of an Individual record.
An xref ID of a Source record.
An xref ID of a Repository record.
An xref ID of a Multimedia record.
An xref ID of a Note record.
An xref ID of a Submitter record.
A CHANGE_DATE() object giving the time this record was last modified. If not provided, the current date is used.
A list of NOTE_STRUCTURE() objects.
A list of SOURCE_CITATION() objects.
A list of SOURCE_REPOSITORY_CITATION() objects.
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.