resolve merge conflicts

Merge branch 'main' into dev # Conflicts: # .Rbuildignore # DESCRIPTION # NEWS.md # R/data.R # R/gen_alternative_terms.R # R/gen_api.R # R/gen_auth.R # R/gen_catalogue.R # R/gen_cube.R # R/gen_find.R # R/gen_list_jobs.R # R/gen_meta_data.R # R/gen_modified_data.R # R/gen_objects2stat.R # R/gen_objects2var.R # R/gen_table.R # R/gen_var2-val2.R # R/utils.R # R/zzz.R # cran-comments.md # man/evas_list.Rd # man/gen_alternative_terms.Rd # man/gen_auth_save.Rd # man/gen_catalogue.Rd # man/gen_cube.Rd # man/gen_find.Rd # man/gen_list_jobs.Rd # man/gen_metadata.Rd # man/gen_metadata_cube.Rd # man/gen_metadata_stats.Rd # man/gen_metadata_tab.Rd # man/gen_metadata_val.Rd # man/gen_metadata_var.Rd # man/gen_modified_data.Rd # man/gen_objects2stat.Rd # man/gen_objects2var.Rd # man/gen_search_vars.Rd # man/gen_table.Rd # man/gen_val2var.Rd # man/gen_val2var2stat.Rd # man/gen_var2stat.Rd
CorrelAid · Jul 21, 2024 · f669442 · f669442
2 parents 016c85c + 4ec7d47
commit f669442
Show file tree

Hide file tree

Showing 39 changed files with 1,349 additions and 72 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -10,3 +10,7 @@
 ^pkgdown$
 ^codecov\.yml$
 ^cran-comments\.md$
+<<<<<<< HEAD
+=======
+^CRAN-SUBMISSION$
+>>>>>>> main
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -2,9 +2,9 @@
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
-    branches: [dev]
+    branches: [main, dev]
   pull_request:
-    branches: [dev]
+    branches: [main, dev]
 
 name: R-CMD-check
 

diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -2,9 +2,9 @@
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
-    branches: [dev]
+    branches: [main, dev]
   pull_request:
-    branches: [dev]
+    branches: [main, dev]
   release:
     types: [published]
   workflow_dispatch:

diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -2,9 +2,9 @@
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
-    branches: [dev]
+    branches: [main, dev]
   pull_request:
-    branches: [dev]
+    branches: [main, dev]
 
 name: test-coverage
 

diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -0,0 +1,3 @@
+Version: 0.1.0
+Date: 2023-06-28 10:04:36 UTC
+SHA: e4b477312427801d3b3cf03fdce906e6c1163b14
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,5 +1,7 @@
 Package: restatis
-Title: R Wrapper to Access a Wide Range of Germany's Federal Statistical System Databases Based on the GENESIS Web Service RESTful API of the German Federal Statistical Office (Statistisches Bundesamt/Destatis)
+Title: R Wrapper to Access a Wide Range of Germany's Federal Statistical System 
+    Databases Based on the GENESIS Web Service RESTful API of the German Federal 
+    Statistical Office (Statistisches Bundesamt/Destatis)
 Version: 0.2.0
 Authors@R: c(
     person("Yannik", "Buhl", , "[email protected]", role = c("aut", "cre")),
@@ -8,22 +10,25 @@ Authors@R: c(
     person("Dorian", "Le Jeune", role = "aut"),
     person("Long", "Nguyen", , "[email protected]", role = "aut",
            comment = c(ORCID = "0000-0001-8878-7386")),
-    person("Johannes", "Ritter", role = "aut")
+    person("Johannes", "Ritter", , "[email protected]", role = "aut")
   )
 Description: A RESTful API wrapper for accessing the GENESIS database of
     the German Federal Statistical Office (Destatis) as well as its Census 
     Database and the database of Germany's regional statistics. Supports data 
     search functions, credential management, result caching, and handling 
     remote background jobs for large datasets.
 License: MIT + file LICENSE
-URL: https://correlaid.github.io/restatis/
+URL: https://correlaid.github.io/restatis/,
+    https://github.com/CorrelAid/restatis
+BugReports: https://github.com/CorrelAid/restatis/issues
 Depends: 
     R (>= 2.10)
 Imports: 
     askpass,
     httr2,
     memoise,
     readr,
+    stats,
     tibble,
     vctrs,
     purrr
@@ -34,6 +39,8 @@ Suggests:
     rmarkdown,
     testthat (>= 3.0.0),
     rvest
+    usethis,
+    withr
 VignetteBuilder: 
     knitr
 Config/testthat/edition: 3

diff --git a/NAMESPACE b/NAMESPACE
@@ -12,8 +12,12 @@ export(gen_logincheck)
 export(gen_metadata)
 export(gen_metadata_cube)
 export(gen_metadata_statistic)
+export(gen_metadata_stats)
+export(gen_metadata_tab)
 export(gen_metadata_table)
+export(gen_metadata_val)
 export(gen_metadata_value)
+export(gen_metadata_var)
 export(gen_metadata_variable)
 export(gen_modified_data)
 export(gen_objects2stat)

diff --git a/NEWS.md b/NEWS.md
@@ -4,3 +4,7 @@
 * Massively improved the handling of 'jobs' (e.g., adding gen_download_job())
 * Added some helper functions such as gen_logincheck()
 * Rewrote functions in the background
+
+# restatis 0.1.0
+
+* Initial CRAN submission.
diff --git a/R/data.R b/R/data.R
@@ -1,4 +1,4 @@
-#' List of EVAS codes
+#' List of EVAS Codes
 #'
 #' @format ## `evas_list`
 #' A data frame with 1132 rows and 3 columns:

diff --git a/R/gen_alternative_terms.R b/R/gen_alternative_terms.R
@@ -29,7 +29,6 @@ gen_alternative_terms <- function(term = NULL,
                                   database = c("all", "genesis", "zensus", "regio"),
                                   verbose = TRUE,
                                   ...) {
-
   caller <- as.character(match.call()[1])
 
   gen_fun <- test_database_function(database,

diff --git a/R/gen_auth.R b/R/gen_auth.R
@@ -12,14 +12,15 @@
 #'   The usethis package includes a helper function for editing .Renviron files
 #'   from an R session with [usethis::edit_r_environ()].
 #'
+#' @return Path to the RDS file in which credentials are saved, invisibly.
+#'
 #' @export
 #'
 #' @examples
 #' \dontrun{
 #' gen_auth_save("zensus")
 #' }
 #'
-#'
 gen_auth_save <- function(database = c("all", "genesis", "zensus", "regio")) {
 
   if (missing(database)) stop("You have to specify a value for parameter 'database'.",
@@ -94,7 +95,6 @@ gen_auth_save <- function(database = c("all", "genesis", "zensus", "regio")) {
 #' gen_auth_get("all")
 #' }
 #'
-#'
 gen_auth_get <- function(database = c("all", "genesis", "zensus", "regio")) {
 
   #-----------------------------------------------------------------------------
@@ -335,4 +335,3 @@ gen_auth_path <- function(...) {
   return(file.path(tools::R_user_dir("restatis", "config"), ...))
 
 }
-
diff --git a/R/gen_catalogue.R b/R/gen_catalogue.R
@@ -20,7 +20,7 @@
 #' # Scroll through objects under the topic "12*"
 #' # which is "Bevoelkerung" in GENESIS from all categories and
 #' # with a detailed output
-#' object <- gen_catalogue(code = "12*", detailed = T)
+#' object <- gen_catalogue(code = "12*", detailed = TRUE)
 #'
 #' # Search tables under the topic "12*" which is "Bevölkerung"
 #' # without a detailed output
@@ -36,7 +36,6 @@ gen_catalogue <- function(code = NULL,
                           error.ignore = FALSE,
                           verbose = TRUE,
                           ...) {
-
   caller <- as.character(match.call()[1])
 
   gen_fun <- test_database_function(database,
@@ -314,4 +313,5 @@ gen_catalogue <- function(code = NULL,
 
   return(res)
 
+
 }
diff --git a/R/gen_cube.R b/R/gen_cube.R
@@ -37,6 +37,9 @@
 #'       descriptions in German (`"de"`) or English (`"en"`)?}
 #'   }
 #'
+#' @return A [tibble][tibble::tibble()]. Non-data contents of the data cube object are saved in
+#'   the `metadata` [attribute][base::attr()] of the data frame.
+#'
 #' @export
 #'
 #' @examples
@@ -45,9 +48,7 @@
 #' }
 #'
 gen_cube <- function(name, ...) {
-
   gen_cube_(name, ...)
-
 }
 
 #-------------------------------------------------------------------------------
@@ -72,7 +73,6 @@ gen_cube_ <- function(name,
                       classifyingkey3 = NULL,
                       stand = NULL,
                       language = Sys.getenv("GENESIS_LANG")) {
-
   area <- match.arg(area)
   database <- match.arg(database)
 

diff --git a/R/gen_find.R b/R/gen_find.R
@@ -1,4 +1,4 @@
-#' gen_find
+#' General Search for Objects Through GENESIS
 #'
 #' @description Function to search through the databases GENESIS, Zensus 2022 and regionalstatistik.de. It is similar in usage as the search function on the GENESIS main page (https://www-genesis.destatis.de/genesis/online).
 #' In the search query, "UND" (German word for 'and', also written "und" or "&") as well as "ODER" (German word for 'or', also written "oder" or "|") can be included and logically combined. Furthermore, wildcards are possible by including "*". If more then one word is included in the term string, 'and' is used automatically to combine the different words.
@@ -39,7 +39,6 @@ gen_find <- function(term = NULL,
                      error.ignore = TRUE,
                      verbose = TRUE,
                      ...) {
-
   caller <- as.character(match.call()[1])
 
   gen_fun <- test_database_function(database,

diff --git a/R/gen_list_jobs.R b/R/gen_list_jobs.R
@@ -0,0 +1,24 @@
+#' Search for Current Jobs of Your User Account
+#'
+#' @description Function to list all current jobs connected to the given user.
+#'
+#' @param selection Filter the list of jobs for matching codes.
+#' @param sortcriterion Allows to sort the resulting list of jobs by their Code ("content"), the time of completion ("time") or status ("status")
+#' @param ... Additional parameter of the GENESIS API call. These parameters are only affecting the GENESIS API call itself, no further processing.
+#'
+#' @return A list of all current jobs connected to the given user.
+#' @export
+#'
+gen_list_jobs <- function(selection = NULL,
+                          sortcriterion = c("content", "time", "status"),
+                          ...) {
+  results_raw <- gen_api("catalogue/jobs",
+    selection = selection,
+    sortcriterion = sortcriterion,
+    ...
+  )
+
+  results_json <- test_if_json(results_raw)
+
+  return(results_json)
+}