Merge pull request #329 from helseprofil/dev

Add geo_map_multi() and update documentation

NAMESPACE

@@ -50,6 +50,7 @@ export(find_implicit_col)
 export(find_implicit_null)
 export(find_spec)
 export(geo_map)
+export(geo_map_multi)
 export(geo_merge)
 export(geo_recode)
 export(get_aar)
@@ -87,6 +88,7 @@ export(read_file)
 export(read_log)
 export(reset_opt)
 export(reset_options)
+export(run_orgdata_hdir)
 export(save_file)
 export(se_fil)
 export(see_data)

NEWS.md

@@ -1,7 +1,8 @@
 # orgdata 1.5.0 (dev)
 
 # orgdata 1.4.9
-- Fix `geo.merge` [d163c9a](https://github.com/helseprofil/orgdata/commit/d163c9ac08996b0a6ab0be5d6faee2bdbd5b2c1c)
+- Add `geo_map_multi()`, to generate a multiyear mappig table. [9b3e1a1](https://github.com/helseprofil/orgdata/commit/9b3e1a1071af6839bdcc1eb1716da33b62867144)
+- Fix `geo_merge()` [d163c9a](https://github.com/helseprofil/orgdata/commit/d163c9ac08996b0a6ab0be5d6faee2bdbd5b2c1c)
 - Allow specification of encoding in `read_file` [ba980a7](https://github.com/helseprofil/orgdata/commit/ba980a791f96a18a4e2f1782f48ca0f48cf36bd2)
 
 # orgdata 1.4.8

R/norgeo.R

@@ -1,7 +1,6 @@
 #' @title Granularity of Geographical Codes
 #' @description Create a database granularity of geographical codes to aggregate
-#'   data accordingly. Implementation of this function is base on [norgeo::cast_geo()]
-#'   function in \href{https://helseprofil.github.io/norgeo/}{norgeo} package.
+#'   data accordingly. Implementation of this function is based on [norgeo::cast_geo()].
 #' @param year Year for the valid geographical codes
 #' @param write Write table to the `orgdata.geo` database. It will overwrite
 #'    the table if it already exists
@@ -60,6 +59,48 @@ geo_map <- function(year = NULL, write = FALSE, append = FALSE, table = "tblGeo"
   return(geo$tblvalue[])
 }
 
+#' @title Granularity of Geographical Codes (multi-year)
+#' @description A wrapper around [geo_map()] to generate a database granularity 
+#'   of geographical codes to aggregate data accordingly, for multiple years.
+#' @param from starting year 
+#' @param to ending year
+#' @param write Write table to the `orgdata.geo` database. It will overwrite
+#'    the table if it already exists
+#' @param table Table name to be created in the database. Default is `tblGeo`
+#' @export
+geo_map_multi <- function(from = NULL,
+                          to = NULL,
+                          write = FALSE,
+                          table = "tblGeo") {
+  if (write) {
+    geoFile <- is_path_db(getOption("orgdata.geo"), check = TRUE)
+    geo <- KHelse$new(geoFile)
+    on.exit(geo$db_close(), add = TRUE)
+  } else {
+    geo <- listenv::listenv()
+  }
+
+  DT <- data.table::data.table()
+
+  for (year in from:to) {
+    message(paste0("Processing year: ", year))
+    dt <- geo_map(year, append = FALSE, write = FALSE)
+    DT <- data.table::rbindlist(list(DT, dt))
+  }
+
+  geo$tblvalue <- DT[, "batch" := is_batch("date")]
+  geo$tblname <- table
+
+  if (write) {
+    is_write_msg(msg = "write")
+    geo$db_write(write = write)
+    msgWrite <- paste0("Write table `", table, "` is completed in: \n")
+    is_verbose(x = geoFile, msg = msgWrite, type = "note")
+  }
+
+  return(geo$tblvalue[])
+}
+
 #' @title Geographical Codes to Recode
 #' @description Create a table of current year geographical codes against previous
 #'  years geogprahical codes. This is used to recode the previous years codes to the

R/utils-misc.R

@@ -220,8 +220,6 @@ is_correct_globs <- function(x){
 #' Temporary fix to run on HDIR systems 
 #'
 #' @export
-#'
-#' @examples
 run_orgdata_hdir <- function(){
   options(orgdata.win.drive = "O:")
   options(orgdata.folder.db = "Prosjekt/FHP/PRODUKSJON/STYRING/raw-khelse")