R/download_language_list.R

In lsteinmann/idaifieldR: Importing Data from Field Desktop / iDAI.field into R

#' Download a Language-List from GitHub
#'
#' This function downloads language lists from the
#' [iDAI.field-GitHub-repository](https://github.com/dainst/idai-field)
#' and can be used to supply additional lists to [get_language_lookup()].
#'
#'
#' @param project name of the project for which the language files should be
#' downloaded; case sensitive! Has to match the name in the Language-file
#' exactly. If default ("core") is used, the common language file from the core
#' library will be downloaded.
#' @param language Language short name that is to be extracted, e.g. "en",
#' defaults to "en"
#'
#'
#' 
#' 
#'
#'
#' @returns A list that can be processed with [get_language_lookup()].
#' @export
#'
#' @examples
#' \dontrun{
#' lang_list <- download_language_list(language = "de")
#' get_language_lookup(lang_list)
#' }
download_language_list <- function(project = "core",
                                   language = "en") {

  base_url <- "https://raw.github.com/dainst/idai-field/master/core/config/"

  if (project != "core") {
    project <- paste0(toupper(substr(project, 1, 1)),
                      substr(project, 2, nchar(project)))
    lang_url <- paste0(base_url, "Language-", project, ".", language, ".json")
  } else {
    lang_url <- c(paste0(base_url, "Core/Language.", language, ".json"),
                  paste0(base_url, "Library/Language.", language, ".json"))
  }
  lang_list <- list()
  for (i in seq_along(lang_url)) {
    new <- jsonlite::read_json(lang_url[i])
    lang_list <- append(lang_list, new)
  }
  other <- which(grepl("archaeoDox", names(lang_list)))
  if (length(other) > 0) {
    lang_list[other] <- NULL
  }
  lang_list <- list(lang_list)
  names(lang_list) <- language

  return(lang_list)
}