R/sf_urls.R

In pttry/statfitools: Helper Functions for Working with the Data from Statistics Finland

#' Statfi url
#'
#' Gives full statfi url
#'
#' @param ... Character vectors.
#' @param .base_url A base url for statfi.
#' @param with_base_url logical, whether to add the base of url to the output.
#'    Defaults to \code{TRUE}
#'
#' @export
#'
#' @examples
#'   statfi_url("StatFin", "muutl/statfin_muutl_pxt_119z.px")
#'
statfi_url <- function(...,
                       with_base_url = TRUE,
                       lang = "fi",
                       .base_url = "https://pxdata.stat.fi/PXWeb/api/v1"){
  if(with_base_url) {
    file.path(.base_url, lang, ..., fsep = "/")
  } else {
    file.path(..., fsep = "/")
  }
}

#' Parse Statfi pxweb api url from web url
#'
#' Safe in these sense that if the argument is already an api url, returns the
#' argument as such.
#'
#' @param url An url from web to parse
#' @param with_base_url logical, whether the concatenate base_url. Defaults to true.
#'
#' @export
#'
#' @examples
#'   statfi_parse_url("https://statfin.stat.fi/PxWeb/pxweb/fi/StatFin/StatFin__muutl/statfin_muutl_pxt_119z.px/")
#'   statfi_parse_url("StatFin__muutl/statfin_muutl_pxt_119z.px/", with_base_url = FALSE)
#'   statfi_parse_url("StatFin__muutl/statfin_muutl_pxt_119z.px/", )
#'   statfi_parse_url("https://pxnet2.stat.fi/PXWeb/api/v1/fi/StatFin/vrm/muutl/statfin_muutl_pxt_119z.px")
#'   statfi_parse_url("https://pxnet2.stat.fi/PXWeb/api/v1/fi/StatFin/vrm/muutl/statfin_muutl_pxt_119z.px", with_base_url = FALSE)
#'
statfi_parse_url <- function(url, with_base_url = TRUE){

  url <- stringr::str_remove(url, "https://pxdata.stat.fi/PxWeb/pxweb/fi/StatFin/")
  url <- stringr::str_remove(url, "https://statfin.stat.fi/PxWeb/pxweb/fi/StatFin/")
  url <- stringr::str_remove(url, "https://pxnet2.stat.fi/PXWeb/api/v1/fi/")
  url <- stringr::str_replace_all(url, "__", "/")
  statfi_url(url, with_base_url = with_base_url)

}

#' @describeIn statfi_parse_url Parsing function for archived databases.
#'
#' @export
#' @examples
#'   statfi_parse_url_arch("https://statfin.stat.fi/PxWeb/pxweb/fi/StatFin_Passiivi/StatFin_Passiivi__kivih/statfinpas_kivih_pxt_001_201812_fi.px/")
statfi_parse_url_arch <- function(url){
  url <- stringr::str_remove(url, "https://pxdata.stat.fi/PxWeb/pxweb/fi/StatFin_Passiivi/")
  url <- stringr::str_remove(url, "https://statfin.stat.fi/PxWeb/pxweb/fi/StatFin_Passiivi/")
  url <- stringr::str_remove(url, "https://pxnet2.stat.fi/PXWeb/pxweb/fi/StatFin_Passiivi/")
  url <- stringr::str_replace_all(url, "__", "/")
  url <- statfi_url(url)
  url
}

#' Parse Statfi pxweb qui url from api url
#'
#' @param url character, url
#'
#' @return A character
#' @export
#'
#' @examples
#'
#'   statfi_parse_qui_url("https://statfin.stat.fi/PXWeb/api/v1/fi/StatFin/muutl/statfin_muutl_pxt_119z.px")
#'
statfi_parse_qui_url <- function(url){

  url <- stringr::str_remove(url, "https://statfin.stat.fi/PxWeb/pxweb/fi/StatFin/")
  url <- stringr::str_remove(url, "https://statfin.stat.fi/PXWeb/api/v1/fi/")
  end <- stringr::str_match(url, "/statfin.*")
  start <- stringr::str_remove(url, end)
  start <- stringr::str_replace_all(start, "/", "__")
  statfi_url(paste0("StatFin/", start, end), with_base_url = TRUE, .base_url = "https://statfin.stat.fi/PxWeb/pxweb")

}

#' Open API url in QUI PxWeb
#'
#' Can be also used with table codes with \code{\link[pttdatahaku]{pttdatahaku}}.
#'
#' @param x character, url or table code. If table code, set db_list_name
#' @param db_list_name character, database of the table
#'
#' @export
#'
#' @examples
#'
#'   open_statfi_qui("https://statfin.stat.fi/PXWeb/api/v1/fi/StatFin/muutl/statfin_muutl_pxt_119z.px")
#'
open_statfi_qui <- function(x = "", db_list_name = NULL) {

  if(!is.null(db_list_name)) {
    x <- pttdatahaku::table_code_to_url(x, db_list_name = db_list_name)
  }

  x <- statfi_parse_qui_url(x)
  browseURL(x)

}

#' Get table code from url
#'
#' @param url A url
#'
#' @export
url_to_table_code <- function(url){

  sapply(url,
         function(x) {paste(stringr::str_match(x, "statfin_\\s*(.*?)\\s*pxt_\\s*(.*?)\\s*.px")[,2:3], collapse = "")},
         USE.NAMES = FALSE)

}