R/lookups.R

In jl5000/tidyged.internals: Internal Data Structures for the 'Tidyged' Package

#' Get valid values for inputs
#' 
#' These functions return the valid values that are allowed by the GEDCOM Specification.
#'
#' @return A character vector of valid values.
#' @export
val_languages <- function() {
  c("English", "Afrikaans", "Albanian", "Anglo-Saxon", "Catalan", "Catalan_Spn", "Czech", 
    "Danish", "Dutch", "Esperanto", "Estonian", "Faroese", "Finnish", 
    "French", "German", "Hawaiian", "Hungarian", "Icelandic", "Indonesian", 
    "Italian", "Latvian", "Lithuanian", "Navaho", "Norwegian", "Polish", 
    "Portuguese", "Romanian", "Serbo_Croa", "Slovak", "Slovene", "Spanish", 
    "Swedish", "Turkish", "Wendic")
}

#' @rdname val_languages
#' @export
val_sexes <- function() {
  c(Unknown = "U", Male = "M", Female = "F", Intersex = "X", `Not recorded` = "N")
}

#' @rdname val_languages
#' @export
val_multimedia_formats <- function() {
  c("AAC", "AVI", "BMP", "ePub", "FLAC", "GIF", "JPEG", "MKV",
    "mobi", "MP3", "PCX", "PDF", "PNG", "TIFF", "WAV")
}

#' @rdname val_languages
#' @export
val_pedigree_linkage_types <- function() {
  vals <- c("birth", "adopted", "foster")
  stats::setNames(vals, tools::toTitleCase(vals))
}

#' @rdname val_languages
#' @export
val_source_media_types <- function() {
  vals <- c("audio", "book", "card", "electronic", "fiche", 
    "film", "magazine", "manuscript", "map", 
    "newspaper", "photo", "tombstone", "video")
  stats::setNames(vals, tools::toTitleCase(vals))
}

#' @rdname val_languages
#' @export
val_adoptive_parents <- function() {
  c(Husband = "HUSB", Wife = "WIFE", Both = "BOTH")
}

#' @rdname val_languages
#' @export
val_roles <- function() {
  c(Child = "CHIL",
    Husband = "HUSB", 
    Wife = "WIFE", 
    Spouse = "SPOU",
    Mother = "MOTH",
    Father = "FATH")
}

#' @rdname val_languages
#' @export
val_attribute_types <- function() {
  c(Caste = "CAST", 
    `Academic achievement` = "EDUC", 
    `National ID number` = "IDNO",
    Nationality = "NATI", 
    `Nobility title` = "TITL", 
    `Number of children` = "NCHI", 
    `Number of relationships` = "NMR", 
    Occupation = "OCCU",
    `Physical description` = "DSCR", 
    Property = "PROP", 
    Religion = "RELI", 
    Residence = "RESI",
    `Other individual attribute` = "FACT")
}

#' @rdname val_languages
#' @export
val_family_event_types <- function() {
  c(Annulment = "ANUL", 
    Census = "CENS", 
    Divorce = "DIV", 
    `Divorce filed` = "DIVF",
    Engagement = "ENGA", 
    `Marriage banns` = "MARB", 
    `Marriage contract` = "MARC", 
    `Marriage license` = "MARL", 
    `Marriage settlement` = "MARS",
    Relationship = "MARR",
    Residence = "RESI",
    `Other event` = "EVEN")
}

#' @rdname val_languages
#' @export
val_individual_event_types <- function() {
  c(Adoption = "ADOP", 
    `Adult christening` = "CHRA", 
    Baptism = "BAPM",
    `Bar-mitzvah` = "BARM", 
    `Bas-mitzvah` = "BASM",
    Birth = "BIRT", 
    Burial = "BURI",
    Census = "CENS",
    Christening = "CHR", 
    Confirmation = "CONF", 
    Cremation = "CREM",
    Death = "DEAT", 
    Emigration = "EMIG", 
    `First communion` = "FCOM", 
    Graduation = "GRAD", 
    Immigration = "IMMI", 
    Naturalization = "NATU",
    Probate = "PROB", 
    Retirement = "RETI",
    Will = "WILL",
    `Other event` = "EVEN")
}