diff --git a/LICENSE.html b/LICENSE.html index 38cb1b0..200bffd 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -34,7 +34,7 @@

MIT License

- Source: LICENSE.md + Source: LICENSE.md
diff --git a/articles/additional_parameter.html b/articles/additional_parameter.html index 86bf30d..c1712d6 100644 --- a/articles/additional_parameter.html +++ b/articles/additional_parameter.html @@ -60,7 +60,7 @@

Additional Parameters for API Calls with {restatis}

- Source: vignettes/additional_parameter.Rmd + Source: vignettes/additional_parameter.Rmd
additional_parameter.Rmd
diff --git a/articles/restatis.html b/articles/restatis.html index d39d382..af40407 100644 --- a/articles/restatis.html +++ b/articles/restatis.html @@ -60,7 +60,7 @@

Basic restatis Workflow

- Source: vignettes/restatis.Rmd + Source: vignettes/restatis.Rmd
restatis.Rmd
diff --git a/authors.html b/authors.html index 654eb11..00271d4 100644 --- a/authors.html +++ b/authors.html @@ -63,7 +63,7 @@

Authors

Citation

-

Source: DESCRIPTION

+

Source: DESCRIPTION

Buhl Y, Kovacevic Z, Le Jeune D, Nguyen L, Ritter J (2024). restatis: 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). diff --git a/news/index.html b/news/index.html index 291271b..f5c0fcb 100644 --- a/news/index.html +++ b/news/index.html @@ -34,7 +34,7 @@

Changelog

- Source: NEWS.md + Source: NEWS.md
diff --git a/pkgdown.yml b/pkgdown.yml index cd4618d..1515cd0 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -4,7 +4,7 @@ pkgdown_sha: ~ articles: additional_parameter: additional_parameter.html restatis: restatis.html -last_built: 2024-12-06T14:39Z +last_built: 2024-12-06T15:57Z urls: reference: https://correlaid.github.io/restatis/reference article: https://correlaid.github.io/restatis/articles diff --git a/reference/binding_lapply.html b/reference/binding_lapply.html index 61a957e..9bd45a4 100644 --- a/reference/binding_lapply.html +++ b/reference/binding_lapply.html @@ -34,7 +34,7 @@

binding_lapply

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
binding_lapply.Rd
diff --git a/reference/check_function_input.html b/reference/check_function_input.html index e12f02c..a113ea5 100644 --- a/reference/check_function_input.html +++ b/reference/check_function_input.html @@ -34,7 +34,7 @@

check_function_input

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
check_function_input.Rd
diff --git a/reference/check_results.html b/reference/check_results.html index 2303e32..bbaef63 100644 --- a/reference/check_results.html +++ b/reference/check_results.html @@ -34,7 +34,7 @@

check_results

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
check_results.Rd
diff --git a/reference/evas_list.html b/reference/evas_list.html index b474f83..6a30702 100644 --- a/reference/evas_list.html +++ b/reference/evas_list.html @@ -34,7 +34,7 @@

List of EVAS Codes

- Source: R/data.R + Source: R/data.R
evas_list.Rd
diff --git a/reference/find_token.html b/reference/find_token.html index 14dfebc..1b6b92b 100644 --- a/reference/find_token.html +++ b/reference/find_token.html @@ -34,7 +34,7 @@

find_token

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
find_token.Rd
diff --git a/reference/forming_evas.html b/reference/forming_evas.html index bad801e..287aee7 100644 --- a/reference/forming_evas.html +++ b/reference/forming_evas.html @@ -34,7 +34,7 @@

forming_evas

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
forming_evas.Rd
diff --git a/reference/gen_alternative_terms.html b/reference/gen_alternative_terms.html index 6d197a6..a49d70a 100644 --- a/reference/gen_alternative_terms.html +++ b/reference/gen_alternative_terms.html @@ -34,7 +34,7 @@

gen_alternative_terms

- Source: R/gen_alternative_terms.R + Source: R/gen_alternative_terms.R
gen_alternative_terms.Rd
diff --git a/reference/gen_auth_ask.html b/reference/gen_auth_ask.html index 7f9e584..30aae6a 100644 --- a/reference/gen_auth_ask.html +++ b/reference/gen_auth_ask.html @@ -34,7 +34,7 @@

gen_auth_ask

- Source: R/gen_auth.R + Source: R/gen_auth.R
gen_auth_ask.Rd
diff --git a/reference/gen_auth_get.html b/reference/gen_auth_get.html index 89389fb..1695007 100644 --- a/reference/gen_auth_get.html +++ b/reference/gen_auth_get.html @@ -34,7 +34,7 @@

gen_auth_get

- Source: R/gen_auth.R + Source: R/gen_auth.R
gen_auth_get.Rd
diff --git a/reference/gen_auth_path.html b/reference/gen_auth_path.html index e8625b2..385e8ba 100644 --- a/reference/gen_auth_path.html +++ b/reference/gen_auth_path.html @@ -34,7 +34,7 @@

gen_auth_path

- Source: R/gen_auth.R + Source: R/gen_auth.R
gen_auth_path.Rd
diff --git a/reference/gen_auth_save.html b/reference/gen_auth_save.html index 0986805..89a6bd0 100644 --- a/reference/gen_auth_save.html +++ b/reference/gen_auth_save.html @@ -34,7 +34,7 @@

gen_auth_save

- Source: R/gen_auth.R + Source: R/gen_auth.R
gen_auth_save.Rd
diff --git a/reference/gen_catalogue.html b/reference/gen_catalogue.html index 0fdf6f5..54ba5c3 100644 --- a/reference/gen_catalogue.html +++ b/reference/gen_catalogue.html @@ -34,7 +34,7 @@

gen_catalogue

- Source: R/gen_catalogue.R + Source: R/gen_catalogue.R
gen_catalogue.Rd
diff --git a/reference/gen_cube.html b/reference/gen_cube.html index 56d9f17..db7b02a 100644 --- a/reference/gen_cube.html +++ b/reference/gen_cube.html @@ -34,7 +34,7 @@

gen_cube

- Source: R/gen_cube.R + Source: R/gen_cube.R
gen_cube.Rd
diff --git a/reference/gen_download_job.html b/reference/gen_download_job.html index c44d8d5..782964e 100644 --- a/reference/gen_download_job.html +++ b/reference/gen_download_job.html @@ -34,7 +34,7 @@

gen_download_job

- Source: R/gen_jobs.R + Source: R/gen_jobs.R
gen_download_job.Rd
@@ -49,7 +49,7 @@

Usage database = c("genesis", "regio"), area = c("all", "public", "user"), compress = FALSE, - language = Sys.getenv("GENESIS_LANG"), + language = Sys.getenv("RESTATIS_LANG"), all_character = TRUE )

@@ -75,7 +75,7 @@

Argumentslanguage -

Character string. Defines if the decimal mark and grouping mark of integers should be represented based on the European (e.g.: '100,5', '200.000,5') or American ('100.5', '200,000.5') system. Defaults to 'Sys.getenv("GENESIS_LANG")'.

+

Character string. Defines if the decimal mark and grouping mark of integers should be represented based on the European (e.g.: '100,5', '200.000,5') or American ('100.5', '200,000.5') system. Defaults to 'Sys.getenv("RESTATIS_LANG")'.

all_character
diff --git a/reference/gen_find.html b/reference/gen_find.html index 6e657a6..dfc4669 100644 --- a/reference/gen_find.html +++ b/reference/gen_find.html @@ -38,7 +38,7 @@

General Search for Objects Through GENESIS

- Source: R/gen_find.R + Source: R/gen_find.R
gen_find.Rd
diff --git a/reference/gen_list_jobs.html b/reference/gen_list_jobs.html index 2f9a300..3c18012 100644 --- a/reference/gen_list_jobs.html +++ b/reference/gen_list_jobs.html @@ -34,7 +34,7 @@

gen_list_jobs

- Source: R/gen_jobs.R + Source: R/gen_jobs.R
gen_list_jobs.Rd
diff --git a/reference/gen_logincheck.html b/reference/gen_logincheck.html index 4d4dd12..9d4b829 100644 --- a/reference/gen_logincheck.html +++ b/reference/gen_logincheck.html @@ -34,7 +34,7 @@

gen_logincheck

- Source: R/gen_logincheck.R + Source: R/gen_logincheck.R
gen_logincheck.Rd
diff --git a/reference/gen_metadata.html b/reference/gen_metadata.html index ffce9b2..f2b8c90 100644 --- a/reference/gen_metadata.html +++ b/reference/gen_metadata.html @@ -34,7 +34,7 @@

gen_metadata

- Source: R/gen_metadata.R + Source: R/gen_metadata.R
gen_metadata.Rd
diff --git a/reference/gen_metadata_cube.html b/reference/gen_metadata_cube.html index 1019b1d..f231178 100644 --- a/reference/gen_metadata_cube.html +++ b/reference/gen_metadata_cube.html @@ -34,7 +34,7 @@

gen_metadata_cube

- Source: R/gen_metadata.R + Source: R/gen_metadata.R
gen_metadata_cube.Rd
diff --git a/reference/gen_metadata_statistic.html b/reference/gen_metadata_statistic.html index 703fc28..30aac25 100644 --- a/reference/gen_metadata_statistic.html +++ b/reference/gen_metadata_statistic.html @@ -34,7 +34,7 @@

gen_metadata_statistic

- Source: R/gen_metadata.R + Source: R/gen_metadata.R
gen_metadata_statistic.Rd
diff --git a/reference/gen_metadata_table.html b/reference/gen_metadata_table.html index 557a7c8..0ee1efb 100644 --- a/reference/gen_metadata_table.html +++ b/reference/gen_metadata_table.html @@ -34,7 +34,7 @@

gen_metadata_table

- Source: R/gen_metadata.R + Source: R/gen_metadata.R
gen_metadata_table.Rd
diff --git a/reference/gen_metadata_value.html b/reference/gen_metadata_value.html index cc02997..9e3df91 100644 --- a/reference/gen_metadata_value.html +++ b/reference/gen_metadata_value.html @@ -34,7 +34,7 @@

gen_metadata_value

- Source: R/gen_metadata.R + Source: R/gen_metadata.R
gen_metadata_value.Rd
diff --git a/reference/gen_metadata_variable.html b/reference/gen_metadata_variable.html index 07cf5d5..b777b17 100644 --- a/reference/gen_metadata_variable.html +++ b/reference/gen_metadata_variable.html @@ -34,7 +34,7 @@

gen_metadata_variable

- Source: R/gen_metadata.R + Source: R/gen_metadata.R
gen_metadata_variable.Rd
diff --git a/reference/gen_modified_data.html b/reference/gen_modified_data.html index c536a01..74de062 100644 --- a/reference/gen_modified_data.html +++ b/reference/gen_modified_data.html @@ -34,7 +34,7 @@

gen_modified_data

- Source: R/gen_modified_data.R + Source: R/gen_modified_data.R
gen_modified_data.Rd
diff --git a/reference/gen_objects2stat.html b/reference/gen_objects2stat.html index 2361d26..17871f7 100644 --- a/reference/gen_objects2stat.html +++ b/reference/gen_objects2stat.html @@ -34,7 +34,7 @@

gen_objects2stat

- Source: R/gen_objects2stat.R + Source: R/gen_objects2stat.R
gen_objects2stat.Rd
diff --git a/reference/gen_objects2var.html b/reference/gen_objects2var.html index 78f20ec..e15939d 100644 --- a/reference/gen_objects2var.html +++ b/reference/gen_objects2var.html @@ -34,7 +34,7 @@

gen_objects2var

- Source: R/gen_objects2var.R + Source: R/gen_objects2var.R
gen_objects2var.Rd
diff --git a/reference/gen_search_vars.html b/reference/gen_search_vars.html index c9e4b56..2f70add 100644 --- a/reference/gen_search_vars.html +++ b/reference/gen_search_vars.html @@ -34,7 +34,7 @@

gen_search_vars

- Source: R/gen_var2-val2.R + Source: R/gen_var2-val2.R
gen_search_vars.Rd
diff --git a/reference/gen_signs.html b/reference/gen_signs.html index cb7e667..530ed83 100644 --- a/reference/gen_signs.html +++ b/reference/gen_signs.html @@ -34,7 +34,7 @@

gen_signs

- Source: R/gen_qualitysigns.R + Source: R/gen_qualitysigns.R
gen_signs.Rd
diff --git a/reference/gen_table.html b/reference/gen_table.html index 992d2ec..cc6a222 100644 --- a/reference/gen_table.html +++ b/reference/gen_table.html @@ -34,7 +34,7 @@

gen_table

- Source: R/gen_table.R + Source: R/gen_table.R
gen_table.Rd
diff --git a/reference/gen_update_evas.html b/reference/gen_update_evas.html index 4dfdbd3..c02d1c1 100644 --- a/reference/gen_update_evas.html +++ b/reference/gen_update_evas.html @@ -34,7 +34,7 @@

gen_update_evas

- Source: R/gen_update_evas.R + Source: R/gen_update_evas.R
gen_update_evas.Rd
diff --git a/reference/gen_val2var.html b/reference/gen_val2var.html index ef2f296..170d4db 100644 --- a/reference/gen_val2var.html +++ b/reference/gen_val2var.html @@ -34,7 +34,7 @@

gen_val2var

- Source: R/gen_var2-val2.R + Source: R/gen_var2-val2.R
gen_val2var.Rd
diff --git a/reference/gen_val2var2stat.html b/reference/gen_val2var2stat.html index 149e9f3..9d6a724 100644 --- a/reference/gen_val2var2stat.html +++ b/reference/gen_val2var2stat.html @@ -34,7 +34,7 @@

gen_val2var2stat

- Source: R/gen_var2-val2.R + Source: R/gen_var2-val2.R
gen_val2var2stat.Rd
diff --git a/reference/gen_var2stat.html b/reference/gen_var2stat.html index a4b36dd..46126a2 100644 --- a/reference/gen_var2stat.html +++ b/reference/gen_var2stat.html @@ -34,7 +34,7 @@

gen_var2stat

- Source: R/gen_var2-val2.R + Source: R/gen_var2-val2.R
gen_var2stat.Rd
diff --git a/reference/ggsub.html b/reference/ggsub.html index cb4d4ac..74a4acd 100644 --- a/reference/ggsub.html +++ b/reference/ggsub.html @@ -34,7 +34,7 @@

ggsub

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
ggsub.Rd
diff --git a/reference/insert_and_save_credentials.html b/reference/insert_and_save_credentials.html index ea10e10..1e5c915 100644 --- a/reference/insert_and_save_credentials.html +++ b/reference/insert_and_save_credentials.html @@ -34,7 +34,7 @@

insert_and_save_credentials

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
insert_and_save_credentials.Rd
diff --git a/reference/is_cube_metadata_header.html b/reference/is_cube_metadata_header.html index a1f33d2..641227d 100644 --- a/reference/is_cube_metadata_header.html +++ b/reference/is_cube_metadata_header.html @@ -34,7 +34,7 @@

is_cube_metadata_header

- Source: R/gen_cube.R + Source: R/gen_cube.R
is_cube_metadata_header.Rd
diff --git a/reference/logincheck_http_error.html b/reference/logincheck_http_error.html index f497f5d..bfa4c35 100644 --- a/reference/logincheck_http_error.html +++ b/reference/logincheck_http_error.html @@ -34,7 +34,7 @@

logincheck_http_error

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
logincheck_http_error.Rd
diff --git a/reference/logincheck_stop_or_warn.html b/reference/logincheck_stop_or_warn.html index 687f5b2..493699a 100644 --- a/reference/logincheck_stop_or_warn.html +++ b/reference/logincheck_stop_or_warn.html @@ -34,7 +34,7 @@

logincheck_stop_or_warn

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
logincheck_stop_or_warn.Rd
diff --git a/reference/param_check_regionalkey.html b/reference/param_check_regionalkey.html index bde4c6e..06b013c 100644 --- a/reference/param_check_regionalkey.html +++ b/reference/param_check_regionalkey.html @@ -34,7 +34,7 @@

param_check_regionalkey

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
param_check_regionalkey.Rd
diff --git a/reference/param_check_year.html b/reference/param_check_year.html index d820d48..a01f462 100644 --- a/reference/param_check_year.html +++ b/reference/param_check_year.html @@ -34,7 +34,7 @@

param_check_year

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
param_check_year.Rd
diff --git a/reference/param_collapse_vec.html b/reference/param_collapse_vec.html index 40a3a53..5fabfca 100644 --- a/reference/param_collapse_vec.html +++ b/reference/param_collapse_vec.html @@ -34,7 +34,7 @@

param_collapse_vec

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
param_collapse_vec.Rd
diff --git a/reference/read_cube.html b/reference/read_cube.html index 6ce7891..a6c6029 100644 --- a/reference/read_cube.html +++ b/reference/read_cube.html @@ -34,7 +34,7 @@

read_cube

- Source: R/gen_cube.R + Source: R/gen_cube.R
read_cube.Rd
diff --git a/reference/read_cube_block.html b/reference/read_cube_block.html index 137d7a2..b4ee52e 100644 --- a/reference/read_cube_block.html +++ b/reference/read_cube_block.html @@ -34,7 +34,7 @@

read_cube_block

- Source: R/gen_cube.R + Source: R/gen_cube.R
read_cube_block.Rd
diff --git a/reference/read_cube_data_lines.html b/reference/read_cube_data_lines.html index e7624bc..213d49d 100644 --- a/reference/read_cube_data_lines.html +++ b/reference/read_cube_data_lines.html @@ -34,7 +34,7 @@

read_cube_data_lines

- Source: R/gen_cube.R + Source: R/gen_cube.R
read_cube_data_lines.Rd
diff --git a/reference/read_cube_metadata_header.html b/reference/read_cube_metadata_header.html index 0405d0f..e21bb57 100644 --- a/reference/read_cube_metadata_header.html +++ b/reference/read_cube_metadata_header.html @@ -34,7 +34,7 @@

read_cube_metadata_header

- Source: R/gen_cube.R + Source: R/gen_cube.R
read_cube_metadata_header.Rd
diff --git a/reference/rename_cube_data_columns.html b/reference/rename_cube_data_columns.html index 0d05dbe..82b9f45 100644 --- a/reference/rename_cube_data_columns.html +++ b/reference/rename_cube_data_columns.html @@ -34,7 +34,7 @@

rename_cube_data_columns

- Source: R/gen_cube.R + Source: R/gen_cube.R
rename_cube_data_columns.Rd
diff --git a/reference/resp_check_data.html b/reference/resp_check_data.html index 8678d25..fbcd84a 100644 --- a/reference/resp_check_data.html +++ b/reference/resp_check_data.html @@ -34,7 +34,7 @@

resp_check_data

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
resp_check_data.Rd
diff --git a/reference/restatis-package.html b/reference/restatis-package.html index ecf1068..fb71ab7 100644 --- a/reference/restatis-package.html +++ b/reference/restatis-package.html @@ -34,7 +34,7 @@

restatis: 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)

- Source: R/restatis-package.R + Source: R/restatis-package.R
restatis-package.Rd
diff --git a/reference/return_table_object.html b/reference/return_table_object.html index 731b3ae..6dd6331 100644 --- a/reference/return_table_object.html +++ b/reference/return_table_object.html @@ -34,7 +34,7 @@

return_table_object

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
return_table_object.Rd
diff --git a/reference/rev_database_function.html b/reference/rev_database_function.html index 94a1b9a..d1c50c5 100644 --- a/reference/rev_database_function.html +++ b/reference/rev_database_function.html @@ -34,7 +34,7 @@

rev_database_function

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
rev_database_function.Rd
diff --git a/reference/spezifisch_create.html b/reference/spezifisch_create.html index 6b33b18..9a31e5e 100644 --- a/reference/spezifisch_create.html +++ b/reference/spezifisch_create.html @@ -34,7 +34,7 @@

spezifisch_create

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
spezifisch_create.Rd
diff --git a/reference/split_cube.html b/reference/split_cube.html index 782f1d1..49acfb3 100644 --- a/reference/split_cube.html +++ b/reference/split_cube.html @@ -34,7 +34,7 @@

split_cube

- Source: R/gen_cube.R + Source: R/gen_cube.R
split_cube.Rd
diff --git a/reference/test_database_function.html b/reference/test_database_function.html index b4dd5ca..946433a 100644 --- a/reference/test_database_function.html +++ b/reference/test_database_function.html @@ -34,7 +34,7 @@

test_database_function

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
test_database_function.Rd
diff --git a/reference/test_if_error.html b/reference/test_if_error.html index a9e06fb..4945b25 100644 --- a/reference/test_if_error.html +++ b/reference/test_if_error.html @@ -34,7 +34,7 @@

test_if_error

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
test_if_error.Rd
diff --git a/reference/test_if_error_find.html b/reference/test_if_error_find.html index d9069b1..df61afe 100644 --- a/reference/test_if_error_find.html +++ b/reference/test_if_error_find.html @@ -34,7 +34,7 @@

test_if_error_find

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
test_if_error_find.Rd
diff --git a/reference/test_if_error_light.html b/reference/test_if_error_light.html index dc958fd..bf1f2a1 100644 --- a/reference/test_if_error_light.html +++ b/reference/test_if_error_light.html @@ -34,7 +34,7 @@

test_if_error_light

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
test_if_error_light.Rd
diff --git a/reference/test_if_error_variables.html b/reference/test_if_error_variables.html index 4567d5b..4d5f929 100644 --- a/reference/test_if_error_variables.html +++ b/reference/test_if_error_variables.html @@ -34,7 +34,7 @@

test_if_error_variables

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
test_if_error_variables.Rd
diff --git a/reference/test_if_json.html b/reference/test_if_json.html index 1f9f42c..9d24b5c 100644 --- a/reference/test_if_json.html +++ b/reference/test_if_json.html @@ -34,7 +34,7 @@

test_if_json

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
test_if_json.Rd
diff --git a/reference/test_if_okay.html b/reference/test_if_okay.html index bcdc101..d11e426 100644 --- a/reference/test_if_okay.html +++ b/reference/test_if_okay.html @@ -34,7 +34,7 @@

test_if_okay

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
test_if_okay.Rd
diff --git a/reference/test_if_process_further.html b/reference/test_if_process_further.html index d378298..b575809 100644 --- a/reference/test_if_process_further.html +++ b/reference/test_if_process_further.html @@ -34,7 +34,7 @@

test_if_process_further

- Source: R/utils_httr2.R + Source: R/utils_httr2.R
test_if_process_further.Rd
diff --git a/reference/titel_search.html b/reference/titel_search.html index 303c7cb..57ab399 100644 --- a/reference/titel_search.html +++ b/reference/titel_search.html @@ -34,7 +34,7 @@

titel_search

- Source: R/utils_dataprocessing.R + Source: R/utils_dataprocessing.R
titel_search.Rd
diff --git a/search.json b/search.json index c286778..74210ea 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://correlaid.github.io/restatis/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 restatis authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"information","dir":"Articles","previous_headings":"","what":"Information","title":"Additional Parameters for API Calls with {restatis}","text":"brief overview additional parameters API call via {restatis}. parameters affect API call , data processing. aware: parameters available functions. Especially gen_table() gen_cube() lot different additional parameters specify API call. detailed overview, see following official documents: GENESIS database: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf","code":""},{"path":[]},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-selection-searchcriterion","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Selection & Searchcriterion","title":"Additional Parameters for API Calls with {restatis}","text":"selection parameter string specifies filter use filtering API call. criterion parameter applied defined searchcriterion parameter. maximum length string depends function used, often times varies 10 15 characters. possible use ‘*’ placeholder. default parameter filtering. searchcriterion parameter string specifies criterion used selection parameter. Possible values depend function used, often times “code” filtering based code “content” filtering based content description. default parameter filter criterion. Often times, searchcriterion parameter sortcriterion parameter possible values. Examples:","code":"# Get the values of the variable \"WAM8\" which code starts with \"WA29\" gen_val2var(\"WAM8\", selection = \"WA29*\", searchcriterion = \"code\", database = \"genesis\") # The same result can be achieved by the following line due to the default of the \"searchcriterion\" parameter: gen_val2var(\"WAM8\", selection = \"WA29*\", database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-sortcriterion","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Sortcriterion","title":"Additional Parameters for API Calls with {restatis}","text":"sortcriterion parameter string specifies whether raw output API call sorted according specified input. Possible values depend function used, often times “code” sorting based code “content” sorting based content description possible. default sorting. Examples:","code":"# Get the values of the variable \"WAM8\" sorted based on their codes gen_val2var(\"WAM8\", sortcriterion = \"code\")"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-pagelength","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Pagelength","title":"Additional Parameters for API Calls with {restatis}","text":"pagelength parameter number 1 2500. indicates maximum length API call output. Default 100. Examples:","code":"# Get the values of the variable \"WAM8\", where the maximum length of the output is 2500 entries gen_val2var(\"WAM8\", pagelength = 2500)"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-language","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Language","title":"Additional Parameters for API Calls with {restatis}","text":"language parameter string. indicates API call output German using “de” English using “en”. Default “en” (API default “de” overwritten {restatis} “en”). Examples:","code":"# Get the values of the variable \"WAM8\" in German gen_val2var(\"WAM8\", language = \"de\") # Get the values of the variable \"WAM8\" in English gen_val2var(\"WAM8\", language = \"en\")"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"explicit-overview-of-additional-parameters-per-function","dir":"Articles","previous_headings":"","what":"Explicit Overview of Additional Parameters per Function","title":"Additional Parameters for API Calls with {restatis}","text":"cubes: (GENESIS regionalstatistik.de) statistics: tables: see following official documentation: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf see following official documentation: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf available GENESIS regionalstatistik.de See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf cubes: (GENESIS regionalstatistik.de) variables: See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf tables: cubes: (GENESIS regionalstatistik.de) statistics: tables: See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf","code":""},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Basic restatis Workflow","text":"vignette describes basic workflow finding, exploring, retrieving data GENESIS, Zensus 2022 regionalstatistik.de API using restatis. details additional parameters can used specify API call, see vignette(\"additional_parameter\"). scenario vignette, going researcher trying find data income bus drivers, called “Busfahrer” German. following example focuses GENESIS database, however, works practically identical regionalstatistik.de. Zensus 2022 database, functions also work almost similarly GENESIS regionalstatistik.de, quirks (cubes Zensus 2022 can also authenticate using API token).","code":""},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"premilinary-finding-relevant-search-terms","dir":"Articles","previous_headings":"","what":"Premilinary: finding relevant search terms","title":"Basic restatis Workflow","text":"First, can explore keyword represented GENESIS database. want see keywords related way words, need precise search process; case already particular keyword, related keywords included search expand data collection. broad possible, want search term database contains keyword. , can use “*” wildcard beginning end search term: Based results, original keyword “busfahrer” already specific enough, additional specifications necessary. started keyword “bus” - vehicle - can see database several related terms might helpful narrow search radius . example, might helpful see least three different types buses searchable: “fernbus”, “schienenbus” “kraftomnibusse”.","code":"restatis::gen_alternative_terms(term = \"*busfahrer*\", database = \"genesis\") gen_alternative_terms(term = \"*bus*\", database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"search-for-data-objects","dir":"Articles","previous_headings":"","what":"Search for data objects","title":"Basic restatis Workflow","text":"Now specific keyword search, can search database exactly term. want results ordered items title includes search term top. also want explore object types now: can see find results keyword “busfahrer” category objects (statistics, tables, variables, cubes). Based promising content description first cube object, next step check contains requesting data. side note, functions package return objects additional attributes represent parameters additional information API query. check attributes ever need help recognising got output.","code":"search_results <- gen_find(term = \"busfahrer\", detailed = FALSE, ordering = TRUE, category = \"all\", database = \"genesis\") search_results"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"checking-object-metadata","dir":"Articles","previous_headings":"","what":"Checking object metadata","title":"Basic restatis Workflow","text":"check whether data objects relevant interest, obtain metadata objects requesting data . metadata type object stores different key characteristics help understand object . question income bus drivers, want check metadata first cube object got find function:","code":"gen_metadata(code = search_results$Cubes$Code[1], category = search_results$Cubes$Object_Type[1], database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"retrieving-data","dir":"Articles","previous_headings":"","what":"Retrieving data","title":"Basic restatis Workflow","text":"now pretty sure cube object help us find information research question. next step get data API. Based fact want cube object, now use gen_cube() function. object types, use corresponding functions (e.g., gen_table() tables). Important note: possible get whole statistic object, possible collect different related cube objects independently try recombine .","code":"gen_cube(search_results$Cubes$Code[1], database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"appendix-check-for-changes-in-previously-collected-data","dir":"Articles","previous_headings":"","what":"Appendix: check for changes in previously collected data","title":"Basic restatis Workflow","text":"small additional step, like check one week later collected data objects updated last week. can also check additional interesting data objects interest/keyword added database. , need specify code objects looking time want look updates. want check something related updated, need use first part code sure covers topic interested . example, use “62361*” want check updated objects published specific statistic “Verdiensterhebung”. convenience, functions already implemented common date specifications, “week_before”, “month_before”, “year_before”. prefer fixed date, can enter string format “DD.MM.YYYY”. example, might want check see something new published collected cube object. use first part code “62361*“:","code":"gen_modified_data(code = \"62361\", date = \"week_before\")"},{"path":"https://correlaid.github.io/restatis/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Yannik Buhl. Author, maintainer. Zoran Kovacevic. Author. Dorian Le Jeune. Author. Long Nguyen. Author. Johannes Ritter. Author.","code":""},{"path":"https://correlaid.github.io/restatis/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Buhl Y, Kovacevic Z, Le Jeune D, Nguyen L, Ritter J (2024). restatis: R Wrapper Access Wide Range Germany's Federal Statistical System Databases Based GENESIS Web Service RESTful API German Federal Statistical Office (Statistisches Bundesamt/Destatis). R package version 0.2.0, https://github.com/CorrelAid/restatis, https://correlaid.github.io/restatis/.","code":"@Manual{, title = {restatis: 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)}, author = {Yannik Buhl and Zoran Kovacevic and Dorian {Le Jeune} and Long Nguyen and Johannes Ritter}, year = {2024}, note = {R package version 0.2.0, https://github.com/CorrelAid/restatis}, url = {https://correlaid.github.io/restatis/}, }"},{"path":"https://correlaid.github.io/restatis/index.html","id":"restatis-","dir":"","previous_headings":"","what":"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)","text":"restatis wrapper around RESTful API provides access three main databases German official statistics: GENESIS database Federal Statistical Office Germany (Destatis). regionalstatistik.de database German Länder (Regionaldatenbank). database German 2022 Census (Zensus 2022). functions work either one , just selection.","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","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)","text":"can install released version {restatis} CRAN: install development version {restatis} GitHub :","code":"install.packages(\"restatis\") # install.packages(\"devtools\") devtools::install_github(\"CorrelAid/restatis\")"},{"path":[]},{"path":"https://correlaid.github.io/restatis/index.html","id":"authentication","dir":"","previous_headings":"Usage","what":"Authentication","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)","text":"access one APIs, need account can create homepage (see links ) store username password use R restatis::gen_auth_save() (see ?gen_auth_save details). Zensus 2022 database support authentication API token well.","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"main-features","dir":"","previous_headings":"Usage","what":"Main features","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)","text":"{restatis} provides functions (prefixed gen_) finding, exploring, retrieving data three supported APIs. See “Basic restatis workflow” vignette overview main features package. short overview, functions divided two main parts, searching (meta)data retrieving data:","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"searching-for-metadata","dir":"","previous_headings":"Usage > Main features","what":"Searching for (meta)data","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)","text":"gen_catalogue(): Search API’s catalogue data gen_find(): Find objects related search term gen_metadata(): Find meta data objects gen_alternative_terms(): Find alternative terms search term gen_modified_data(): Find object last modified gen_objects2stat(), gen_objects2var(), gen_var2stat(), gen_val2var(), gen_val2var2stat() gen_search_vars(): Find objects, statistics, variables values related ","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"retrieving-data","dir":"","previous_headings":"Usage > Main features","what":"Retrieving data","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)","text":"gen_cube(): Using function, can download ‘cube’ objects gen_table(): Using function, can download ‘table’ objects gen_list_jobs() gen_download_job(): Using function, can find download previously created jobs (large tables)","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"other-functions","dir":"","previous_headings":"Usage > Main features","what":"Other functions","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)","text":"gen_logincheck(): Perform logincheck test credentials gen_qualitysigns(): Get list quality signs (special characters) found API’s tables gen_update_evas(): Manually scrape newer version EVAS numbers (official statistic IDs)","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"caching","dir":"","previous_headings":"Usage","what":"Caching","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)","text":"{restatis} uses memoisation cache query results. means call function multiple times input, values returned first time stored reused second time. Cached objects stored memory persist across R sessions.","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"disclaimer","dir":"","previous_headings":"","what":"Disclaimer","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)","text":"package way affiliated German Federal Statistical Office (Destatis) ‘Verbund Statistische Ämter des Bundes und der Länder’. simple wrapper providing R functions access Destatis’ API. package authors way responsible data can retrieved using functions. license package solely applies source code.","code":""},{"path":"https://correlaid.github.io/restatis/reference/binding_lapply.html","id":null,"dir":"Reference","previous_headings":"","what":"binding_lapply — binding_lapply","title":"binding_lapply — binding_lapply","text":"binding_lapply","code":""},{"path":"https://correlaid.github.io/restatis/reference/binding_lapply.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"binding_lapply — binding_lapply","text":"","code":"binding_lapply(x, characteristics)"},{"path":"https://correlaid.github.io/restatis/reference/binding_lapply.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"binding_lapply — binding_lapply","text":"x Element bind characteristics Characteristics filter ","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_function_input.html","id":null,"dir":"Reference","previous_headings":"","what":"check_function_input — check_function_input","title":"check_function_input — check_function_input","text":"check_function_input","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_function_input.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"check_function_input — check_function_input","text":"","code":"check_function_input( code = NULL, term = NULL, sortcriterion = NULL, category = NULL, detailed = NULL, type = NULL, date = NULL, similarity = NULL, error.ignore = NULL, ordering = NULL, database = NULL, area = NULL, caller = NULL, verbose = NULL, raw = NULL )"},{"path":"https://correlaid.github.io/restatis/reference/check_function_input.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"check_function_input — check_function_input","text":"code Parameter checked term Parameter checked sortcriterion Parameter checked category Parameter checked detailed Parameter checked type Parameter checked date Parameter checked similarity Parameter checked error.ignore Parameter checked ordering Parameter checked database Parameter checked area Parameter checked caller Parameter checked verbose Parameter checked raw Parameter checked","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_results.html","id":null,"dir":"Reference","previous_headings":"","what":"check_results — check_results","title":"check_results — check_results","text":"check_results","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_results.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"check_results — check_results","text":"","code":"check_results(input)"},{"path":"https://correlaid.github.io/restatis/reference/check_results.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"check_results — check_results","text":"input Input test result structure","code":""},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List of EVAS Codes — evas_list","title":"List of EVAS Codes — evas_list","text":"List EVAS Codes","code":""},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List of EVAS Codes — evas_list","text":"","code":"evas_list"},{"path":[]},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":"evas-list","dir":"Reference","previous_headings":"","what":"evas_list","title":"List of EVAS Codes — evas_list","text":"data frame 1132 rows 3 columns: EVAS EVAS code Beschreibung Details EVAS code Titel Alternative desription EVAS code contents","code":""},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"List of EVAS Codes — evas_list","text":"https://www.destatis.de/DE/Methoden/Revisionen/Glossar/EVAS.html","code":""},{"path":"https://correlaid.github.io/restatis/reference/find_token.html","id":null,"dir":"Reference","previous_headings":"","what":"find_token — find_token","title":"find_token — find_token","text":"find_token","code":""},{"path":"https://correlaid.github.io/restatis/reference/find_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"find_token — find_token","text":"","code":"find_token(input, error.input, text, sub_category)"},{"path":"https://correlaid.github.io/restatis/reference/find_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"find_token — find_token","text":"input Input test result structure error.input error.ignore TRUE FALSE text verbose TRUE FALSE sub_category sub_category character string","code":""},{"path":"https://correlaid.github.io/restatis/reference/forming_evas.html","id":null,"dir":"Reference","previous_headings":"","what":"forming_evas — forming_evas","title":"forming_evas — forming_evas","text":"forming_evas","code":""},{"path":"https://correlaid.github.io/restatis/reference/forming_evas.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"forming_evas — forming_evas","text":"","code":"forming_evas(list_of)"},{"path":"https://correlaid.github.io/restatis/reference/forming_evas.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"forming_evas — forming_evas","text":"list_of List EVAS iterate ","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_alternative_terms — gen_alternative_terms","title":"gen_alternative_terms — gen_alternative_terms","text":"Function find search terms similar related one another spelling also represented GENESIS, Zensus 2022 regionalstatistik.de databases. Important note: API call searching terms characters. useful searching related terms highly recommended work \"*\" placeholders (see examples). placeholder can placed /search term.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_alternative_terms — gen_alternative_terms","text":"","code":"gen_alternative_terms( term = NULL, similarity = TRUE, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_alternative_terms — gen_alternative_terms","text":"term Character string. Maximum length 15 characters. Term word searching alternative related terms. Use '*' placeholder possible generate broader search areas. similarity Boolean. Indicator output function sorted based Levenshtein edit distance based adist() function. Default 'TRUE'. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_alternative_terms — gen_alternative_terms","text":"list recollected elements respective database. Attributes added data.frame, describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_alternative_terms — gen_alternative_terms","text":"","code":"if (FALSE) { # \\dontrun{ # Find terms at GENESIS that are the same (in spelling) to search term \"bus\" # and sort them by Levenshtein edit distance object <- gen_alternative_terms(term = \"bus\", similarity = TRUE, database = \"genesis\") # Find terms at GENESIS that are related (in spelling) to search term \"bus\" object <- gen_alternative_terms(term = \"bus*\", similarity = TRUE, database = \"genesis\") # Find terms at Zensus 2022 that are related (in spelling) to search term \"wohn\" object <- gen_alternative_terms(term = \"wohn*\", similarity = TRUE, database = \"zensus\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_ask — gen_auth_ask","title":"gen_auth_ask — gen_auth_ask","text":"gen_auth_ask","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_ask — gen_auth_ask","text":"","code":"gen_auth_ask(credential_type)"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_ask — gen_auth_ask","text":"credential_type Character string. Type credential ask ","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_ask — gen_auth_ask","text":"user response","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_get — gen_auth_get","title":"gen_auth_get — gen_auth_get","text":"Function retrieve credentials stored via gen_auth_save()","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_get — gen_auth_get","text":"","code":"gen_auth_get(database = c(\"all\", \"genesis\", \"zensus\", \"regio\"))"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_get — gen_auth_get","text":"database Character string. database get credentials ('', 'genesis', 'zensus' 'regio').","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_get — gen_auth_get","text":"Credentials database(s) chosen user","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_auth_get — gen_auth_get","text":"","code":"if (FALSE) { # \\dontrun{ gen_auth_get(\"all\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_path — gen_auth_path","title":"gen_auth_path — gen_auth_path","text":"gen_auth_path","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_path — gen_auth_path","text":"","code":"gen_auth_path(...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_path — gen_auth_path","text":"... Optional arguments file.path()","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_path — gen_auth_path","text":"file path storage config files","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_save — gen_auth_save","title":"gen_auth_save — gen_auth_save","text":"Save credentials different databases convenient use","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_save — gen_auth_save","text":"","code":"gen_auth_save(database = c(\"all\", \"genesis\", \"zensus\", \"regio\"))"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_save — gen_auth_save","text":"database Character string. database store credentials ('', 'genesis', 'zensus' 'regio').","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_save — gen_auth_save","text":"Path RDS file credentials saved, invisibly.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"gen_auth_save — gen_auth_save","text":"Username password encrypted saved RDS package config directory. random string generated stored session environment variable GENESIS_KEY. string used key encrypt decrypt entered credentials. avoid havding save authentication future sessions, GENESIS_KEY can added .Renviron. usethis package includes helper function editing .Renviron files R session usethis::edit_r_environ().","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_auth_save — gen_auth_save","text":"","code":"if (FALSE) { # \\dontrun{ gen_auth_save(\"zensus\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_catalogue — gen_catalogue","title":"gen_catalogue — gen_catalogue","text":"Function search tables, statistics, cubes GENESIS, Zensus 2022 regionalstatistik.de. Additionally, structures output based internal tree structure based EVAS-numbers. Time-series represented cubes specified time span. Important note: useful searching objects highly recommended work \"*\" placeholders (see examples). placeholder can placed /search term.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_catalogue — gen_catalogue","text":"","code":"gen_catalogue( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"tables\", \"statistics\", \"cubes\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_catalogue — gen_catalogue","text":"code String maximum length 15 characters database object (GENESIS regionalstatistik.de) 15 characters Zensus 2022 object. one code per iteration. \"*\" notations possible. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_catalogue — gen_catalogue","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_catalogue — gen_catalogue","text":"","code":"if (FALSE) { # \\dontrun{ # 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 = TRUE) # Search tables under the topic \"12*\" which is \"Bevölkerung\" # without a detailed output object <- gen_catalogue(code = \"12*\", category = \"tables\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_cube — gen_cube","title":"gen_cube — gen_cube","text":"Download cube data GENESIS regionalstatistik.de database","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_cube — gen_cube","text":"","code":"gen_cube(name, ...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_cube — gen_cube","text":"name Character string cube object (GENESIS regionalstatistik.de) ... (optional) parameters passed API call: area Character string. area table stored. Possible values: \"public\": cube public catalogue \"user\": cube user's account \"\": values Boolean. values included? metadata Boolean. metadata included? additionals Boolean. additional metadata included? contents Character string. Names required statistical specifications startyear,endyear Four-digit integers. retrieve data years. timeslices Integer. Number timeslices (cumulative startyear endyear) regionalvariable Character string. Code regional variable whose value specified regionalkey filter results. regionalkey Character string. One regional keys. Multiple values can supplied character vector single string, regional keys separated commas. Use wildcard (*) allowed. classifyingvariable1,classifyingvariable2 ,classifyingvariable3 Character string. Code subject classification (SK-Merkmal) selection means corresponding classifyingkey parameter applied. classifyingkey1,classifyingkey2,classifyingkey3 Character string. One values subject classification (e.g. \"WZ93012\"). Applied corresponding classifyingvariable parameter. Multiple keys can supplied character vector single string, keys separated commas. Use wildcard (*) allowed. stand Character string, format: \"DD.MM.YYYY\". retrieve data updated date. language Character string. Search terms, returned messages data descriptions German (\"de\") English (\"en\")?","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_cube — gen_cube","text":"tibble. Non-data contents data cube object saved metadata attribute data frame.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_cube — gen_cube","text":"","code":"if (FALSE) { # \\dontrun{ gen_cube(\"47414BJ002\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_download_job — gen_download_job","title":"gen_download_job — gen_download_job","text":"gen_download_job","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_download_job — gen_download_job","text":"","code":"gen_download_job( name, database = c(\"genesis\", \"regio\"), area = c(\"all\", \"public\", \"user\"), compress = FALSE, language = Sys.getenv(\"GENESIS_LANG\"), all_character = TRUE )"},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_download_job — gen_download_job","text":"name Character string. job code retrieved using gen_list_jobs(). database Character string. Indicator GENESIS ('genesis') regionalstatistik.de ('regio') database called. one database can addressed per function call. Default option 'genesis'. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. compress Boolean. empty rows columns discarded? Default FALSE. language Character string. Defines decimal mark grouping mark integers represented based European (e.g.: '100,5', '200.000,5') American ('100.5', '200,000.5') system. Defaults 'Sys.getenv(\"GENESIS_LANG\")'. all_character Boolean. variables imported 'character' variables? Avoids fuzzy data type conversions leading zeros special characters. Defaults TRUE.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_download_job — gen_download_job","text":"Returns data.frame table content","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_download_job — gen_download_job","text":"","code":"if (FALSE) { # \\dontrun{ gen_download_job(\"21311-00-01-1_123456789\", \"regio\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":null,"dir":"Reference","previous_headings":"","what":"General Search for Objects Through GENESIS — gen_find","title":"General Search for Objects Through GENESIS — gen_find","text":"Function search databases GENESIS, Zensus 2022 regionalstatistik.de. similar usage search function GENESIS main page (https://www-genesis.destatis.de/genesis/online). search query, \"UND\" (German word '', also written \"und\" \"&\") well \"ODER\" (German word '', also written \"oder\" \"|\") can included logically combined. Furthermore, wildcards possible including \"*\". one word included term string, '' used automatically combine different words. Important note: Time-series treated cubes GENESIS regionalstatistik.de, longer distinguished. want find specific object clear code find function, need specify object type search object types.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"General Search for Objects Through GENESIS — gen_find","text":"","code":"gen_find( term = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"all\", \"tables\", \"statistics\", \"variables\", \"cubes\"), detailed = FALSE, ordering = TRUE, error.ignore = TRUE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"General Search for Objects Through GENESIS — gen_find","text":"term character string maximum character length, word limit five words. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. ordering logical. Indicator function return output iteration ordered first based fact searched term appearing title object secondly estimator number variables object. Default option 'TRUE'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'TRUE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"General Search for Objects Through GENESIS — gen_find","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"General Search for Objects Through GENESIS — gen_find","text":"","code":"if (FALSE) { # \\dontrun{ # Find objects related to \"bus\" in GENESIS object <- gen_find(term = \"bus\") # Find tables related to \"bus\" in GENESIS and return a unordered detailed output object <- gen_find(term = \"bus\", detailed = TRUE, ordering = FALSE) # Find tables related to \"Autos\" or \"Corona\" in GENESIS and return a unordered detailed output object <- gen_find(term = \"autos ODER corona\", detailed = TRUE, ordering = FALSE) #' # Find tables related to \"Autos\" and \"Corona\" in GENESIS and return a unordered detailed output object <- gen_find(term = \"autos UND corona\", detailed = TRUE, ordering = FALSE) } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_list_jobs — gen_list_jobs","title":"gen_list_jobs — gen_list_jobs","text":"Function list current jobs connected given user GENESIS regionalstatistik.de database. Important note: function also possible use searchcriterion parameter selection parameter, making possible filter job list based 'type','time','status' 'code'. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_list_jobs — gen_list_jobs","text":"","code":"gen_list_jobs( database = c(\"genesis\", \"regio\"), sortcriterion = c(\"type\", \"time\", \"status\", \"code\"), flat = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_list_jobs — gen_list_jobs","text":"database Character string. Indicator 'genesis' 'regionalstatistik.de' database called. Default option 'genesis'. sortcriterion Character string. Indicator output sorted 'type','time','status' 'code'. parameter API call . default 'type'. flat Boolean. function return list jobs metadata ('FALSE') just flat data.frame ('TRUE')? Defaults FALSE. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_list_jobs — gen_list_jobs","text":"list data.frame (see parameter 'flat') current jobs user.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_list_jobs — gen_list_jobs","text":"","code":"if (FALSE) { # \\dontrun{ gen_list_jobs(\"regio\", flat = TRUE) } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_logincheck — gen_logincheck","title":"gen_logincheck — gen_logincheck","text":"Function check login possible certain database.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_logincheck — gen_logincheck","text":"","code":"gen_logincheck(database, verbose = FALSE)"},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_logincheck — gen_logincheck","text":"database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. one database can addressed per function call. Default option 'genesis'. verbose Boolean. case success, message printed? Defaults FALSE.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_logincheck — gen_logincheck","text":"Leads informative error message login check failed returns FALSE invisibly. Invisibly returns TRUE otherwise.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_logincheck — gen_logincheck","text":"","code":"if (FALSE) { # \\dontrun{ gen_logincheck(\"zensus\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata — gen_metadata","title":"gen_metadata — gen_metadata","text":"Search Meta-Information Types Objects","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata — gen_metadata","text":"","code":"gen_metadata( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"cube\", \"statistic\", \"table\", \"variable\", \"value\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata — gen_metadata","text":"code String maximum length 15 characters database object (GENESIS, regionalstatistik.de, Zensus 2022). one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specifying specific object type object want meta data . default option - need specify object type. Hint: functions 'restatis' often return information object 'Type'. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata — gen_metadata","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata — gen_metadata","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the table with the code \"11111\" object <- gen_metadata(code = \"11111\", category = \"table\", database = \"genesis\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_cube — gen_metadata_cube","title":"gen_metadata_cube — gen_metadata_cube","text":"Function search meta information specific cube. Usable GENESIS regionalstatistik.de.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_cube — gen_metadata_cube","text":"","code":"gen_metadata_cube( code = NULL, database = c(\"all\", \"genesis\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_cube — gen_metadata_cube","text":"code character string maximum length 15 characters. Code GENESIS regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_cube — gen_metadata_cube","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_cube — gen_metadata_cube","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the cube with the code \"11111KE001\" object <- gen_metadata_cube(code = \"11111KE001\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_statistic — gen_metadata_statistic","title":"gen_metadata_statistic — gen_metadata_statistic","text":"Function search meta information specific statistic.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_statistic — gen_metadata_statistic","text":"","code":"gen_metadata_statistic( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_statistic — gen_metadata_statistic","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_statistic — gen_metadata_statistic","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_statistic — gen_metadata_statistic","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the statistic with the code \"12411\" object <- gen_metadata_stats(code = \"12411\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_table — gen_metadata_table","title":"gen_metadata_table — gen_metadata_table","text":"Function search meta information specific table.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_table — gen_metadata_table","text":"","code":"gen_metadata_table( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_table — gen_metadata_table","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_table — gen_metadata_table","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_table — gen_metadata_table","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the table with the code \"11111\" object <- gen_metadata_tab(code = \"11111\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_value — gen_metadata_value","title":"gen_metadata_value — gen_metadata_value","text":"Function search meta information specific value.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_value — gen_metadata_value","text":"","code":"gen_metadata_value( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_value — gen_metadata_value","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_value — gen_metadata_value","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_value — gen_metadata_value","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the value with the code \"LEDIG\" object <- gen_metadata_val(code = \"LEDIG\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_variable — gen_metadata_variable","title":"gen_metadata_variable — gen_metadata_variable","text":"Function search meta information specific variable.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_variable — gen_metadata_variable","text":"","code":"gen_metadata_variable( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_variable — gen_metadata_variable","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_variable — gen_metadata_variable","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_variable — gen_metadata_variable","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the variable with the code \"FAMSTD\" object <- gen_metadata_var(code = \"FAMSTD\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_modified_data — gen_modified_data","title":"gen_modified_data — gen_modified_data","text":"Function check updates, changes, new objects based specific date.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_modified_data — gen_modified_data","text":"","code":"gen_modified_data( code = \"\", database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), type = c(\"all\", \"tables\", \"statistics\", \"statisticsUpdates\"), date = c(\"now\", \"week_before\", \"month_before\", \"year_before\"), verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_modified_data — gen_modified_data","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. type Character string. Specific GENESIS regionalstatistik.de object types: 'tables', 'statistics', 'statisticsUpdates'. Specific Zensus 2022 object types: 'tables' 'statistics'. types specific one database can used together '', default. date Character string. Specific date used last update upload time include object return. Default option 'now', uses current date system. Alternative options 'week_before', using current date system minus 7 days, 'month_before', using current date system minus 4 weeks, 'year_before', using current date system minus 52 weeks. Additionally, possible fill specific date format 'DD.MM.YYYY'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_modified_data — gen_modified_data","text":"list recalled elements API. Always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_modified_data — gen_modified_data","text":"","code":"if (FALSE) { # \\dontrun{ # Find objects which were modified last_week object <- gen_modified_data(date = \"week_before\") # Find tables that were new from 31.03.2020 object <- gen_modified_data(type = \"tables\", date = \"31.03.2020\") # Find objects related to the topic \"Bevölkerung\" (Code: '12*') which were new today object <- gen_modified_data(code = \"12*\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_objects2stat — gen_objects2stat","title":"gen_objects2stat — gen_objects2stat","text":"Function find objects related statistic","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_objects2stat — gen_objects2stat","text":"","code":"gen_objects2stat( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"tables\", \"variables\", \"cubes\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_objects2stat — gen_objects2stat","text":"code Character string maximum length 6 characters (15 characters 'cubes' used category). Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_objects2stat — gen_objects2stat","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_objects2stat — gen_objects2stat","text":"","code":"if (FALSE) { # \\dontrun{ # Find cubes from the statistic with the code \"21111\" with a detailed return object <- gen_objects2stat(code = \"21111\", category = \"cubes\", detailed = T) # Find all object types from the statistic with the code \"12411\" object <- gen_objects2stat(code = \"12411\") # Default of detailed-parameter is FALSE, and default of the # category-parameter is to include all object types. } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_objects2var — gen_objects2var","title":"gen_objects2var — gen_objects2var","text":"Function find objects related variable","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_objects2var — gen_objects2var","text":"","code":"gen_objects2var( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"tables\", \"statistics\", \"cubes\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_objects2var — gen_objects2var","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_objects2var — gen_objects2var","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_objects2var — gen_objects2var","text":"","code":"if (FALSE) { # \\dontrun{ # Find Tables for Variable \"Kreise\" and return detailed output object <- gen_objects2var(code = \"Kreise\", category = \"tables\", detailed = T) # Find everything for Variable \"GES\" object <- gen_objects2var(code = \"GES\") # Default of detailed-parameter is FALSE, and default of the # category-parameter is to include all object types. } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_search_vars — gen_search_vars","title":"gen_search_vars — gen_search_vars","text":"Function search specific variables","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_search_vars — gen_search_vars","text":"","code":"gen_search_vars( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_search_vars — gen_search_vars","text":"code Character string maximum length 6 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_search_vars — gen_search_vars","text":"list recalled elements API. Always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_search_vars — gen_search_vars","text":"","code":"if (FALSE) { # \\dontrun{ # Find a specific variable \"GES\" in Genesis object <- gen_search_vars(\"GES\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_signs — gen_signs","title":"gen_signs — gen_signs","text":"Function list currently used special signs (e.g., 0, *, X, (), p, ...) meaning GENESIS, Zensus 2022 /regionalstatistik.de.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_signs — gen_signs","text":"","code":"gen_signs(database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), ...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_signs — gen_signs","text":"database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_signs — gen_signs","text":"list current used special signs.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_table — gen_table","title":"gen_table — gen_table","text":"Download table data GENESIS, Zensus 2022 regionalstatistik.de databases","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_table — gen_table","text":"","code":"gen_table(name, ...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_table — gen_table","text":"name Character string. Name/code table. Use wildcards (*) possible. ... Optional parameters passed Genesis API call: area Character string. area table stored. Possible values: \"public\": table public catalogue \"user\": table user's account \"\": compress Boolean. empty rows columns discarded? transpose Boolean. Reshape table \"wide\" \"long\" format. startyear,endyear Four-digit integers. retrieve data years. regionalvariable Character string. Code regional variable whose value specified regionalkey filter results. regionalkey Character string. One regional keys. Multiple values can supplied character vector single string, regional keys separated commas. Use wildcard (*) allowed. classifyingvariable1,classifyingvariable2 ,classifyingvariable3 Character string. Code subject classification (SK-Merkmal) selection means corresponding classifyingkey parameter applied. classifyingkey1,classifyingkey2,classifyingkey3 Character string. One values subject classification (e.g. \"WZ93012\"). Applied corresponding classifyingvariable parameter. Multiple keys can supplied character vector single string, keys separated commas. Use wildcard (*) allowed. stand Character string, format: \"DD.MM.YYYY\". retrieve data updated date. language Search terms, returned messages data descriptions German (\"de\") English (\"en\")? job Boolean. Indicate whether job created (available 'Zensus' database).) all_character Boolean. variables imported 'character' variables? Avoids fuzzy data type conversions leading zeros special characters. Defaults TRUE.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_table — gen_table","text":"tibble.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_table — gen_table","text":"","code":"if (FALSE) { # \\dontrun{ gen_table(\"21311-0001\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_update_evas.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_update_evas — gen_update_evas","title":"gen_update_evas — gen_update_evas","text":"Function web scrape EVAS numbers EVAS website save .rda file. Takes parameters.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_update_evas.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_update_evas — gen_update_evas","text":"","code":"gen_update_evas()"},{"path":"https://correlaid.github.io/restatis/reference/gen_update_evas.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_update_evas — gen_update_evas","text":"updated .rda file containing latest EVAS numbers","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_val2var — gen_val2var","title":"gen_val2var — gen_val2var","text":"Function extract possible values variable. Values continuous variables extractable, function returns warning message case.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_val2var — gen_val2var","text":"","code":"gen_val2var( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), sortcriterion = c(\"code\", \"content\"), error.ignore = TRUE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_val2var — gen_val2var","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator values function stop error occurs object request found produce token response. Default option 'TRUE', prevents function stop even variable explanation (often case numerical variables). verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_val2var — gen_val2var","text":"list recalled elements API. Always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_val2var — gen_val2var","text":"","code":"if (FALSE) { # \\dontrun{ # Find the values of the variable \"DLAND\" object <- gen_val2var(code = \"DLAND\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_val2var2stat — gen_val2var2stat","title":"gen_val2var2stat — gen_val2var2stat","text":"Get values variables statistic. Values continuous variables extracted, function returns warning message.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_val2var2stat — gen_val2var2stat","text":"","code":"gen_val2var2stat( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore.var = FALSE, error.ignore.val = TRUE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_val2var2stat — gen_val2var2stat","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore.var Boolean. Indicator variables function stop error occurs object request found produce token response. Default option 'FALSE'. error.ignore.val Boolean. Indicator values function stop error occurs object request found produce token response. Default option 'TRUE', prevents function stop even variable explanation (often case numerical variables). verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_val2var2stat — gen_val2var2stat","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_val2var2stat — gen_val2var2stat","text":"","code":"if (FALSE) { # \\dontrun{ # Find the values of variables in a specific statistic with # the code \"21111\" and a detailed description of the variables object <- gen_val2var2stat(code = \"21111\", detailed = TRUE) } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_var2stat — gen_var2stat","title":"gen_var2stat — gen_var2stat","text":"Function generate variables statistics","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_var2stat — gen_var2stat","text":"","code":"gen_var2stat( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_var2stat — gen_var2stat","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_var2stat — gen_var2stat","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_var2stat — gen_var2stat","text":"","code":"if (FALSE) { # \\dontrun{ # Find the variables of the statistic with the code \"12411\" # with a detailed output object <- gen_var2stat(code = \"12411\", detailed = T) } # }"},{"path":"https://correlaid.github.io/restatis/reference/ggsub.html","id":null,"dir":"Reference","previous_headings":"","what":"ggsub — ggsub","title":"ggsub — ggsub","text":"ggsub","code":""},{"path":"https://correlaid.github.io/restatis/reference/ggsub.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ggsub — ggsub","text":"","code":"ggsub(x)"},{"path":"https://correlaid.github.io/restatis/reference/ggsub.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ggsub — ggsub","text":"x Element subset $Content","code":""},{"path":"https://correlaid.github.io/restatis/reference/insert_and_save_credentials.html","id":null,"dir":"Reference","previous_headings":"","what":"insert_and_save_credentials — insert_and_save_credentials","title":"insert_and_save_credentials — insert_and_save_credentials","text":"insert_and_save_credentials","code":""},{"path":"https://correlaid.github.io/restatis/reference/insert_and_save_credentials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"insert_and_save_credentials — insert_and_save_credentials","text":"","code":"insert_and_save_credentials(database)"},{"path":"https://correlaid.github.io/restatis/reference/insert_and_save_credentials.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"insert_and_save_credentials — insert_and_save_credentials","text":"database database specify credentials ","code":""},{"path":"https://correlaid.github.io/restatis/reference/is_cube_metadata_header.html","id":null,"dir":"Reference","previous_headings":"","what":"is_cube_metadata_header — is_cube_metadata_header","title":"is_cube_metadata_header — is_cube_metadata_header","text":"is_cube_metadata_header","code":""},{"path":"https://correlaid.github.io/restatis/reference/is_cube_metadata_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"is_cube_metadata_header — is_cube_metadata_header","text":"","code":"is_cube_metadata_header(lines)"},{"path":"https://correlaid.github.io/restatis/reference/is_cube_metadata_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"is_cube_metadata_header — is_cube_metadata_header","text":"lines Lines check header","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":null,"dir":"Reference","previous_headings":"","what":"logincheck_http_error — logincheck_http_error","title":"logincheck_http_error — logincheck_http_error","text":"logincheck_http_error","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"logincheck_http_error — logincheck_http_error","text":"","code":"logincheck_http_error(database, verbose)"},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"logincheck_http_error — logincheck_http_error","text":"database user input 'gen_logincheck' verbose Boolean. function message case success?","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"logincheck_http_error — logincheck_http_error","text":"Informative error/warning messages + invisibly TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":null,"dir":"Reference","previous_headings":"","what":"logincheck_stop_or_warn — logincheck_stop_or_warn","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"logincheck_stop_or_warn","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"","code":"logincheck_stop_or_warn(response, error, verbose, database)"},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"response HTTP response object error Boolean. function warn throw error? verbose Boolean. function message case success? database database check run ","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"case failure warns errors. Invisibly returns TRUE (success) FALSE (failure)","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_regionalkey.html","id":null,"dir":"Reference","previous_headings":"","what":"param_check_regionalkey — param_check_regionalkey","title":"param_check_regionalkey — param_check_regionalkey","text":"param_check_regionalkey","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_regionalkey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"param_check_regionalkey — param_check_regionalkey","text":"","code":"param_check_regionalkey(regionalkey)"},{"path":"https://correlaid.github.io/restatis/reference/param_check_regionalkey.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"param_check_regionalkey — param_check_regionalkey","text":"regionalkey Regional key","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_year.html","id":null,"dir":"Reference","previous_headings":"","what":"param_check_year — param_check_year","title":"param_check_year — param_check_year","text":"param_check_year","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_year.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"param_check_year — param_check_year","text":"","code":"param_check_year(year)"},{"path":"https://correlaid.github.io/restatis/reference/param_check_year.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"param_check_year — param_check_year","text":"year Year parameter value","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_collapse_vec.html","id":null,"dir":"Reference","previous_headings":"","what":"param_collapse_vec — param_collapse_vec","title":"param_collapse_vec — param_collapse_vec","text":"param_collapse_vec","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_collapse_vec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"param_collapse_vec — param_collapse_vec","text":"","code":"param_collapse_vec(vec)"},{"path":"https://correlaid.github.io/restatis/reference/param_collapse_vec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"param_collapse_vec — param_collapse_vec","text":"vec Vector collapsed","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube — read_cube","title":"read_cube — read_cube","text":"read_cube","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube — read_cube","text":"","code":"read_cube(resp)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube — read_cube","text":"resp API response object resulting call 'data/cubefile'","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_block.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube_block — read_cube_block","title":"read_cube_block — read_cube_block","text":"read_cube_block","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_block.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube_block — read_cube_block","text":"","code":"read_cube_block(lines)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube_block.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube_block — read_cube_block","text":"lines Lines read header","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_data_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube_data_lines — read_cube_data_lines","title":"read_cube_data_lines — read_cube_data_lines","text":"read_cube_data_lines","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_data_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube_data_lines — read_cube_data_lines","text":"","code":"read_cube_data_lines(lines, col_names)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube_data_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube_data_lines — read_cube_data_lines","text":"lines Lines read data col_names Specify column names","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_metadata_header.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube_metadata_header — read_cube_metadata_header","title":"read_cube_metadata_header — read_cube_metadata_header","text":"read_cube_metadata_header","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_metadata_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube_metadata_header — read_cube_metadata_header","text":"","code":"read_cube_metadata_header(line, rename_dups = TRUE)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube_metadata_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube_metadata_header — read_cube_metadata_header","text":"line Line read rename_dups Rename duplicates?","code":""},{"path":"https://correlaid.github.io/restatis/reference/rename_cube_data_columns.html","id":null,"dir":"Reference","previous_headings":"","what":"rename_cube_data_columns — rename_cube_data_columns","title":"rename_cube_data_columns — rename_cube_data_columns","text":"rename_cube_data_columns","code":""},{"path":"https://correlaid.github.io/restatis/reference/rename_cube_data_columns.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"rename_cube_data_columns — rename_cube_data_columns","text":"","code":"rename_cube_data_columns(cube)"},{"path":"https://correlaid.github.io/restatis/reference/rename_cube_data_columns.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"rename_cube_data_columns — rename_cube_data_columns","text":"cube cube object rename columns ","code":""},{"path":"https://correlaid.github.io/restatis/reference/resp_check_data.html","id":null,"dir":"Reference","previous_headings":"","what":"resp_check_data — resp_check_data","title":"resp_check_data — resp_check_data","text":"resp_check_data","code":""},{"path":"https://correlaid.github.io/restatis/reference/resp_check_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"resp_check_data — resp_check_data","text":"","code":"resp_check_data(resp)"},{"path":"https://correlaid.github.io/restatis/reference/resp_check_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"resp_check_data — resp_check_data","text":"resp Response object","code":""},{"path":"https://correlaid.github.io/restatis/reference/restatis-package.html","id":null,"dir":"Reference","previous_headings":"","what":"restatis: 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) — restatis-package","title":"restatis: 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) — restatis-package","text":"RESTful API wrapper accessing GENESIS database German Federal Statistical Office (Destatis) well Census Database database Germany's regional statistics. Supports data search functions, credential management, result caching, handling remote background jobs large datasets.","code":""},{"path":[]},{"path":"https://correlaid.github.io/restatis/reference/restatis-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"restatis: 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) — restatis-package","text":"Maintainer: Yannik Buhl ybuhl@posteo.de Authors: Zoran Kovacevic (ORCID) Dorian Le Jeune Long Nguyen long.nguyen@uni-bielefeld.de (ORCID) Johannes Ritter ritter.johannes@gmail.com","code":""},{"path":"https://correlaid.github.io/restatis/reference/return_table_object.html","id":null,"dir":"Reference","previous_headings":"","what":"return_table_object — return_table_object","title":"return_table_object — return_table_object","text":"return_table_object","code":""},{"path":"https://correlaid.github.io/restatis/reference/return_table_object.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"return_table_object — return_table_object","text":"","code":"return_table_object(response, response_type, language, all_character)"},{"path":"https://correlaid.github.io/restatis/reference/return_table_object.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"return_table_object — return_table_object","text":"response Response object response_type Response type language Language locale all_character Read variables character?","code":""},{"path":"https://correlaid.github.io/restatis/reference/rev_database_function.html","id":null,"dir":"Reference","previous_headings":"","what":"rev_database_function — rev_database_function","title":"rev_database_function — rev_database_function","text":"rev_database_function","code":""},{"path":"https://correlaid.github.io/restatis/reference/rev_database_function.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"rev_database_function — rev_database_function","text":"","code":"rev_database_function(input)"},{"path":"https://correlaid.github.io/restatis/reference/rev_database_function.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"rev_database_function — rev_database_function","text":"input Input test database name","code":""},{"path":"https://correlaid.github.io/restatis/reference/spezifisch_create.html","id":null,"dir":"Reference","previous_headings":"","what":"spezifisch_create — spezifisch_create","title":"spezifisch_create — spezifisch_create","text":"spezifisch_create","code":""},{"path":"https://correlaid.github.io/restatis/reference/spezifisch_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"spezifisch_create — spezifisch_create","text":"","code":"spezifisch_create(x)"},{"path":"https://correlaid.github.io/restatis/reference/spezifisch_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"spezifisch_create — spezifisch_create","text":"x Element extract $Spezifisch ","code":""},{"path":"https://correlaid.github.io/restatis/reference/split_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"split_cube — split_cube","title":"split_cube — split_cube","text":"split_cube","code":""},{"path":"https://correlaid.github.io/restatis/reference/split_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"split_cube — split_cube","text":"","code":"split_cube(lines)"},{"path":"https://correlaid.github.io/restatis/reference/split_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"split_cube — split_cube","text":"lines Lines split cube","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_database_function.html","id":null,"dir":"Reference","previous_headings":"","what":"test_database_function — test_database_function","title":"test_database_function — test_database_function","text":"test_database_function","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_database_function.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_database_function — test_database_function","text":"","code":"test_database_function(input, error.input, text)"},{"path":"https://correlaid.github.io/restatis/reference/test_database_function.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_database_function — test_database_function","text":"input Input test database name error.input Indicator error.ignore text Indicator verbose","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error — test_if_error","title":"test_if_error — test_if_error","text":"test_if_error","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error — test_if_error","text":"","code":"test_if_error(input, para, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error — test_if_error","text":"input Response object para Parameter TRUE/FALSE verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_find.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error_find — test_if_error_find","title":"test_if_error_find — test_if_error_find","text":"test_if_error_find","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_find.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error_find — test_if_error_find","text":"","code":"test_if_error_find(input, para, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_find.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error_find — test_if_error_find","text":"input Response object para Parameter TRUE/FALSE verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_light.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error_light — test_if_error_light","title":"test_if_error_light — test_if_error_light","text":"test_if_error_light","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_light.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error_light — test_if_error_light","text":"","code":"test_if_error_light(input, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_light.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error_light — test_if_error_light","text":"input Response object verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_variables.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error_variables — test_if_error_variables","title":"test_if_error_variables — test_if_error_variables","text":"test_if_error_variables","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_variables.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error_variables — test_if_error_variables","text":"","code":"test_if_error_variables(input, para)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_variables.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error_variables — test_if_error_variables","text":"input Response object para Parameter TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_json.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_json — test_if_json","title":"test_if_json — test_if_json","text":"test_if_json","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_json.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_json — test_if_json","text":"","code":"test_if_json(input)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_json.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_json — test_if_json","text":"input Response object","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_okay.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_okay — test_if_okay","title":"test_if_okay — test_if_okay","text":"test_if_okay","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_okay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_okay — test_if_okay","text":"","code":"test_if_okay(input)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_okay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_okay — test_if_okay","text":"input Response object","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_process_further.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_process_further — test_if_process_further","title":"test_if_process_further — test_if_process_further","text":"test_if_process_further","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_process_further.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_process_further — test_if_process_further","text":"","code":"test_if_process_further(input, para, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_process_further.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_process_further — test_if_process_further","text":"input Response object para Parameter TRUE/FALSE verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/titel_search.html","id":null,"dir":"Reference","previous_headings":"","what":"titel_search — titel_search","title":"titel_search — titel_search","text":"titel_search","code":""},{"path":"https://correlaid.github.io/restatis/reference/titel_search.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"titel_search — titel_search","text":"","code":"titel_search(x, term, text)"},{"path":"https://correlaid.github.io/restatis/reference/titel_search.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"titel_search — titel_search","text":"x Element extract $Content term Search term text Indicator verbose","code":""},{"path":"https://correlaid.github.io/restatis/news/index.html","id":"restatis-020","dir":"Changelog","previous_headings":"","what":"restatis 0.2.0","title":"restatis 0.2.0","text":"CRAN release: 2024-07-25 Added support regionalstatistik.de Zensus 2022 database Massively improved handling ‘jobs’ (e.g., adding gen_download_job()) Added helper functions gen_logincheck() Rewrote functions background","code":""},{"path":"https://correlaid.github.io/restatis/news/index.html","id":"restatis-010","dir":"Changelog","previous_headings":"","what":"restatis 0.1.0","title":"restatis 0.1.0","text":"CRAN release: 2023-06-30 Initial CRAN submission.","code":""}] +[{"path":"https://correlaid.github.io/restatis/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 restatis authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"information","dir":"Articles","previous_headings":"","what":"Information","title":"Additional Parameters for API Calls with {restatis}","text":"brief overview additional parameters API call via {restatis}. parameters affect API call , data processing. aware: parameters available functions. Especially gen_table() gen_cube() lot different additional parameters specify API call. detailed overview, see following official documents: GENESIS database: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf","code":""},{"path":[]},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-selection-searchcriterion","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Selection & Searchcriterion","title":"Additional Parameters for API Calls with {restatis}","text":"selection parameter string specifies filter use filtering API call. criterion parameter applied defined searchcriterion parameter. maximum length string depends function used, often times varies 10 15 characters. possible use ‘*’ placeholder. default parameter filtering. searchcriterion parameter string specifies criterion used selection parameter. Possible values depend function used, often times “code” filtering based code “content” filtering based content description. default parameter filter criterion. Often times, searchcriterion parameter sortcriterion parameter possible values. Examples:","code":"# Get the values of the variable \"WAM8\" which code starts with \"WA29\" gen_val2var(\"WAM8\", selection = \"WA29*\", searchcriterion = \"code\", database = \"genesis\") # The same result can be achieved by the following line due to the default of the \"searchcriterion\" parameter: gen_val2var(\"WAM8\", selection = \"WA29*\", database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-sortcriterion","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Sortcriterion","title":"Additional Parameters for API Calls with {restatis}","text":"sortcriterion parameter string specifies whether raw output API call sorted according specified input. Possible values depend function used, often times “code” sorting based code “content” sorting based content description possible. default sorting. Examples:","code":"# Get the values of the variable \"WAM8\" sorted based on their codes gen_val2var(\"WAM8\", sortcriterion = \"code\")"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-pagelength","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Pagelength","title":"Additional Parameters for API Calls with {restatis}","text":"pagelength parameter number 1 2500. indicates maximum length API call output. Default 100. Examples:","code":"# Get the values of the variable \"WAM8\", where the maximum length of the output is 2500 entries gen_val2var(\"WAM8\", pagelength = 2500)"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"parameter-language","dir":"Articles","previous_headings":"Short Overview of the Most Used Additional Parameters","what":"Parameter: Language","title":"Additional Parameters for API Calls with {restatis}","text":"language parameter string. indicates API call output German using “de” English using “en”. Default “en” (API default “de” overwritten {restatis} “en”). Examples:","code":"# Get the values of the variable \"WAM8\" in German gen_val2var(\"WAM8\", language = \"de\") # Get the values of the variable \"WAM8\" in English gen_val2var(\"WAM8\", language = \"en\")"},{"path":"https://correlaid.github.io/restatis/articles/additional_parameter.html","id":"explicit-overview-of-additional-parameters-per-function","dir":"Articles","previous_headings":"","what":"Explicit Overview of Additional Parameters per Function","title":"Additional Parameters for API Calls with {restatis}","text":"cubes: (GENESIS regionalstatistik.de) statistics: tables: see following official documentation: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf see following official documentation: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf available GENESIS regionalstatistik.de See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf cubes: (GENESIS regionalstatistik.de) variables: See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf tables: cubes: (GENESIS regionalstatistik.de) statistics: tables: See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation GENESIS: https://www-genesis.destatis.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf See following official documentation Zensus 2022 database: https://ergebnisse.zensus2022.de/datenbank/online/docs/ZENSUS-Webservices_Einfuehrung.pdf See following official documentation regionalstatistik.de: https://www.regionalstatistik.de/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf","code":""},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Basic restatis Workflow","text":"vignette describes basic workflow finding, exploring, retrieving data GENESIS, Zensus 2022 regionalstatistik.de API using restatis. details additional parameters can used specify API call, see vignette(\"additional_parameter\"). scenario vignette, going researcher trying find data income bus drivers, called “Busfahrer” German. following example focuses GENESIS database, however, works practically identical regionalstatistik.de. Zensus 2022 database, functions also work almost similarly GENESIS regionalstatistik.de, quirks (cubes Zensus 2022 can also authenticate using API token).","code":""},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"premilinary-finding-relevant-search-terms","dir":"Articles","previous_headings":"","what":"Premilinary: finding relevant search terms","title":"Basic restatis Workflow","text":"First, can explore keyword represented GENESIS database. want see keywords related way words, need precise search process; case already particular keyword, related keywords included search expand data collection. broad possible, want search term database contains keyword. , can use “*” wildcard beginning end search term: Based results, original keyword “busfahrer” already specific enough, additional specifications necessary. started keyword “bus” - vehicle - can see database several related terms might helpful narrow search radius . example, might helpful see least three different types buses searchable: “fernbus”, “schienenbus” “kraftomnibusse”.","code":"restatis::gen_alternative_terms(term = \"*busfahrer*\", database = \"genesis\") gen_alternative_terms(term = \"*bus*\", database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"search-for-data-objects","dir":"Articles","previous_headings":"","what":"Search for data objects","title":"Basic restatis Workflow","text":"Now specific keyword search, can search database exactly term. want results ordered items title includes search term top. also want explore object types now: can see find results keyword “busfahrer” category objects (statistics, tables, variables, cubes). Based promising content description first cube object, next step check contains requesting data. side note, functions package return objects additional attributes represent parameters additional information API query. check attributes ever need help recognising got output.","code":"search_results <- gen_find(term = \"busfahrer\", detailed = FALSE, ordering = TRUE, category = \"all\", database = \"genesis\") search_results"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"checking-object-metadata","dir":"Articles","previous_headings":"","what":"Checking object metadata","title":"Basic restatis Workflow","text":"check whether data objects relevant interest, obtain metadata objects requesting data . metadata type object stores different key characteristics help understand object . question income bus drivers, want check metadata first cube object got find function:","code":"gen_metadata(code = search_results$Cubes$Code[1], category = search_results$Cubes$Object_Type[1], database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"retrieving-data","dir":"Articles","previous_headings":"","what":"Retrieving data","title":"Basic restatis Workflow","text":"now pretty sure cube object help us find information research question. next step get data API. Based fact want cube object, now use gen_cube() function. object types, use corresponding functions (e.g., gen_table() tables). Important note: possible get whole statistic object, possible collect different related cube objects independently try recombine .","code":"gen_cube(search_results$Cubes$Code[1], database = \"genesis\")"},{"path":"https://correlaid.github.io/restatis/articles/restatis.html","id":"appendix-check-for-changes-in-previously-collected-data","dir":"Articles","previous_headings":"","what":"Appendix: check for changes in previously collected data","title":"Basic restatis Workflow","text":"small additional step, like check one week later collected data objects updated last week. can also check additional interesting data objects interest/keyword added database. , need specify code objects looking time want look updates. want check something related updated, need use first part code sure covers topic interested . example, use “62361*” want check updated objects published specific statistic “Verdiensterhebung”. convenience, functions already implemented common date specifications, “week_before”, “month_before”, “year_before”. prefer fixed date, can enter string format “DD.MM.YYYY”. example, might want check see something new published collected cube object. use first part code “62361*“:","code":"gen_modified_data(code = \"62361\", date = \"week_before\")"},{"path":"https://correlaid.github.io/restatis/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Yannik Buhl. Author, maintainer. Zoran Kovacevic. Author. Dorian Le Jeune. Author. Long Nguyen. Author. Johannes Ritter. Author.","code":""},{"path":"https://correlaid.github.io/restatis/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Buhl Y, Kovacevic Z, Le Jeune D, Nguyen L, Ritter J (2024). restatis: R Wrapper Access Wide Range Germany's Federal Statistical System Databases Based GENESIS Web Service RESTful API German Federal Statistical Office (Statistisches Bundesamt/Destatis). R package version 0.2.0, https://github.com/CorrelAid/restatis, https://correlaid.github.io/restatis/.","code":"@Manual{, title = {restatis: 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)}, author = {Yannik Buhl and Zoran Kovacevic and Dorian {Le Jeune} and Long Nguyen and Johannes Ritter}, year = {2024}, note = {R package version 0.2.0, https://github.com/CorrelAid/restatis}, url = {https://correlaid.github.io/restatis/}, }"},{"path":"https://correlaid.github.io/restatis/index.html","id":"restatis-","dir":"","previous_headings":"","what":"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)","text":"restatis wrapper around RESTful API provides access three main databases German official statistics: GENESIS database Federal Statistical Office Germany (Destatis). regionalstatistik.de database German Länder (Regionaldatenbank). database German 2022 Census (Zensus 2022). functions work either one , just selection.","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","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)","text":"can install released version {restatis} CRAN: install development version {restatis} GitHub :","code":"install.packages(\"restatis\") # install.packages(\"devtools\") devtools::install_github(\"CorrelAid/restatis\")"},{"path":[]},{"path":"https://correlaid.github.io/restatis/index.html","id":"authentication","dir":"","previous_headings":"Usage","what":"Authentication","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)","text":"access one APIs, need account can create homepage (see links ) store username password use R restatis::gen_auth_save() (see ?gen_auth_save details). Zensus 2022 database support authentication API token well.","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"main-features","dir":"","previous_headings":"Usage","what":"Main features","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)","text":"{restatis} provides functions (prefixed gen_) finding, exploring, retrieving data three supported APIs. See “Basic restatis workflow” vignette overview main features package. short overview, functions divided two main parts, searching (meta)data retrieving data:","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"searching-for-metadata","dir":"","previous_headings":"Usage > Main features","what":"Searching for (meta)data","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)","text":"gen_catalogue(): Search API’s catalogue data gen_find(): Find objects related search term gen_metadata(): Find meta data objects gen_alternative_terms(): Find alternative terms search term gen_modified_data(): Find object last modified gen_objects2stat(), gen_objects2var(), gen_var2stat(), gen_val2var(), gen_val2var2stat() gen_search_vars(): Find objects, statistics, variables values related ","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"retrieving-data","dir":"","previous_headings":"Usage > Main features","what":"Retrieving data","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)","text":"gen_cube(): Using function, can download ‘cube’ objects gen_table(): Using function, can download ‘table’ objects gen_list_jobs() gen_download_job(): Using function, can find download previously created jobs (large tables)","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"other-functions","dir":"","previous_headings":"Usage > Main features","what":"Other functions","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)","text":"gen_logincheck(): Perform logincheck test credentials gen_qualitysigns(): Get list quality signs (special characters) found API’s tables gen_update_evas(): Manually scrape newer version EVAS numbers (official statistic IDs)","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"caching","dir":"","previous_headings":"Usage","what":"Caching","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)","text":"{restatis} uses memoisation cache query results. means call function multiple times input, values returned first time stored reused second time. Cached objects stored memory persist across R sessions.","code":""},{"path":"https://correlaid.github.io/restatis/index.html","id":"disclaimer","dir":"","previous_headings":"","what":"Disclaimer","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)","text":"package way affiliated German Federal Statistical Office (Destatis) ‘Verbund Statistische Ämter des Bundes und der Länder’. simple wrapper providing R functions access Destatis’ API. package authors way responsible data can retrieved using functions. license package solely applies source code.","code":""},{"path":"https://correlaid.github.io/restatis/reference/binding_lapply.html","id":null,"dir":"Reference","previous_headings":"","what":"binding_lapply — binding_lapply","title":"binding_lapply — binding_lapply","text":"binding_lapply","code":""},{"path":"https://correlaid.github.io/restatis/reference/binding_lapply.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"binding_lapply — binding_lapply","text":"","code":"binding_lapply(x, characteristics)"},{"path":"https://correlaid.github.io/restatis/reference/binding_lapply.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"binding_lapply — binding_lapply","text":"x Element bind characteristics Characteristics filter ","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_function_input.html","id":null,"dir":"Reference","previous_headings":"","what":"check_function_input — check_function_input","title":"check_function_input — check_function_input","text":"check_function_input","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_function_input.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"check_function_input — check_function_input","text":"","code":"check_function_input( code = NULL, term = NULL, sortcriterion = NULL, category = NULL, detailed = NULL, type = NULL, date = NULL, similarity = NULL, error.ignore = NULL, ordering = NULL, database = NULL, area = NULL, caller = NULL, verbose = NULL, raw = NULL )"},{"path":"https://correlaid.github.io/restatis/reference/check_function_input.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"check_function_input — check_function_input","text":"code Parameter checked term Parameter checked sortcriterion Parameter checked category Parameter checked detailed Parameter checked type Parameter checked date Parameter checked similarity Parameter checked error.ignore Parameter checked ordering Parameter checked database Parameter checked area Parameter checked caller Parameter checked verbose Parameter checked raw Parameter checked","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_results.html","id":null,"dir":"Reference","previous_headings":"","what":"check_results — check_results","title":"check_results — check_results","text":"check_results","code":""},{"path":"https://correlaid.github.io/restatis/reference/check_results.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"check_results — check_results","text":"","code":"check_results(input)"},{"path":"https://correlaid.github.io/restatis/reference/check_results.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"check_results — check_results","text":"input Input test result structure","code":""},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List of EVAS Codes — evas_list","title":"List of EVAS Codes — evas_list","text":"List EVAS Codes","code":""},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List of EVAS Codes — evas_list","text":"","code":"evas_list"},{"path":[]},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":"evas-list","dir":"Reference","previous_headings":"","what":"evas_list","title":"List of EVAS Codes — evas_list","text":"data frame 1132 rows 3 columns: EVAS EVAS code Beschreibung Details EVAS code Titel Alternative desription EVAS code contents","code":""},{"path":"https://correlaid.github.io/restatis/reference/evas_list.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"List of EVAS Codes — evas_list","text":"https://www.destatis.de/DE/Methoden/Revisionen/Glossar/EVAS.html","code":""},{"path":"https://correlaid.github.io/restatis/reference/find_token.html","id":null,"dir":"Reference","previous_headings":"","what":"find_token — find_token","title":"find_token — find_token","text":"find_token","code":""},{"path":"https://correlaid.github.io/restatis/reference/find_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"find_token — find_token","text":"","code":"find_token(input, error.input, text, sub_category)"},{"path":"https://correlaid.github.io/restatis/reference/find_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"find_token — find_token","text":"input Input test result structure error.input error.ignore TRUE FALSE text verbose TRUE FALSE sub_category sub_category character string","code":""},{"path":"https://correlaid.github.io/restatis/reference/forming_evas.html","id":null,"dir":"Reference","previous_headings":"","what":"forming_evas — forming_evas","title":"forming_evas — forming_evas","text":"forming_evas","code":""},{"path":"https://correlaid.github.io/restatis/reference/forming_evas.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"forming_evas — forming_evas","text":"","code":"forming_evas(list_of)"},{"path":"https://correlaid.github.io/restatis/reference/forming_evas.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"forming_evas — forming_evas","text":"list_of List EVAS iterate ","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_alternative_terms — gen_alternative_terms","title":"gen_alternative_terms — gen_alternative_terms","text":"Function find search terms similar related one another spelling also represented GENESIS, Zensus 2022 regionalstatistik.de databases. Important note: API call searching terms characters. useful searching related terms highly recommended work \"*\" placeholders (see examples). placeholder can placed /search term.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_alternative_terms — gen_alternative_terms","text":"","code":"gen_alternative_terms( term = NULL, similarity = TRUE, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_alternative_terms — gen_alternative_terms","text":"term Character string. Maximum length 15 characters. Term word searching alternative related terms. Use '*' placeholder possible generate broader search areas. similarity Boolean. Indicator output function sorted based Levenshtein edit distance based adist() function. Default 'TRUE'. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_alternative_terms — gen_alternative_terms","text":"list recollected elements respective database. Attributes added data.frame, describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_alternative_terms.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_alternative_terms — gen_alternative_terms","text":"","code":"if (FALSE) { # \\dontrun{ # Find terms at GENESIS that are the same (in spelling) to search term \"bus\" # and sort them by Levenshtein edit distance object <- gen_alternative_terms(term = \"bus\", similarity = TRUE, database = \"genesis\") # Find terms at GENESIS that are related (in spelling) to search term \"bus\" object <- gen_alternative_terms(term = \"bus*\", similarity = TRUE, database = \"genesis\") # Find terms at Zensus 2022 that are related (in spelling) to search term \"wohn\" object <- gen_alternative_terms(term = \"wohn*\", similarity = TRUE, database = \"zensus\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_ask — gen_auth_ask","title":"gen_auth_ask — gen_auth_ask","text":"gen_auth_ask","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_ask — gen_auth_ask","text":"","code":"gen_auth_ask(credential_type)"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_ask — gen_auth_ask","text":"credential_type Character string. Type credential ask ","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_ask.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_ask — gen_auth_ask","text":"user response","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_get — gen_auth_get","title":"gen_auth_get — gen_auth_get","text":"Function retrieve credentials stored via gen_auth_save()","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_get — gen_auth_get","text":"","code":"gen_auth_get(database = c(\"all\", \"genesis\", \"zensus\", \"regio\"))"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_get — gen_auth_get","text":"database Character string. database get credentials ('', 'genesis', 'zensus' 'regio').","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_get — gen_auth_get","text":"Credentials database(s) chosen user","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_auth_get — gen_auth_get","text":"","code":"if (FALSE) { # \\dontrun{ gen_auth_get(\"all\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_path — gen_auth_path","title":"gen_auth_path — gen_auth_path","text":"gen_auth_path","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_path — gen_auth_path","text":"","code":"gen_auth_path(...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_path — gen_auth_path","text":"... Optional arguments file.path()","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_path — gen_auth_path","text":"file path storage config files","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_auth_save — gen_auth_save","title":"gen_auth_save — gen_auth_save","text":"Save credentials different databases convenient use","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_auth_save — gen_auth_save","text":"","code":"gen_auth_save(database = c(\"all\", \"genesis\", \"zensus\", \"regio\"))"},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_auth_save — gen_auth_save","text":"database Character string. database store credentials ('', 'genesis', 'zensus' 'regio').","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_auth_save — gen_auth_save","text":"Path RDS file credentials saved, invisibly.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"gen_auth_save — gen_auth_save","text":"Username password encrypted saved RDS package config directory. random string generated stored session environment variable GENESIS_KEY. string used key encrypt decrypt entered credentials. avoid havding save authentication future sessions, GENESIS_KEY can added .Renviron. usethis package includes helper function editing .Renviron files R session usethis::edit_r_environ().","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_auth_save.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_auth_save — gen_auth_save","text":"","code":"if (FALSE) { # \\dontrun{ gen_auth_save(\"zensus\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_catalogue — gen_catalogue","title":"gen_catalogue — gen_catalogue","text":"Function search tables, statistics, cubes GENESIS, Zensus 2022 regionalstatistik.de. Additionally, structures output based internal tree structure based EVAS-numbers. Time-series represented cubes specified time span. Important note: useful searching objects highly recommended work \"*\" placeholders (see examples). placeholder can placed /search term.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_catalogue — gen_catalogue","text":"","code":"gen_catalogue( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"tables\", \"statistics\", \"cubes\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_catalogue — gen_catalogue","text":"code String maximum length 15 characters database object (GENESIS regionalstatistik.de) 15 characters Zensus 2022 object. one code per iteration. \"*\" notations possible. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_catalogue — gen_catalogue","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_catalogue.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_catalogue — gen_catalogue","text":"","code":"if (FALSE) { # \\dontrun{ # 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 = TRUE) # Search tables under the topic \"12*\" which is \"Bevölkerung\" # without a detailed output object <- gen_catalogue(code = \"12*\", category = \"tables\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_cube — gen_cube","title":"gen_cube — gen_cube","text":"Download cube data GENESIS regionalstatistik.de database","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_cube — gen_cube","text":"","code":"gen_cube(name, ...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_cube — gen_cube","text":"name Character string cube object (GENESIS regionalstatistik.de) ... (optional) parameters passed API call: area Character string. area table stored. Possible values: \"public\": cube public catalogue \"user\": cube user's account \"\": values Boolean. values included? metadata Boolean. metadata included? additionals Boolean. additional metadata included? contents Character string. Names required statistical specifications startyear,endyear Four-digit integers. retrieve data years. timeslices Integer. Number timeslices (cumulative startyear endyear) regionalvariable Character string. Code regional variable whose value specified regionalkey filter results. regionalkey Character string. One regional keys. Multiple values can supplied character vector single string, regional keys separated commas. Use wildcard (*) allowed. classifyingvariable1,classifyingvariable2 ,classifyingvariable3 Character string. Code subject classification (SK-Merkmal) selection means corresponding classifyingkey parameter applied. classifyingkey1,classifyingkey2,classifyingkey3 Character string. One values subject classification (e.g. \"WZ93012\"). Applied corresponding classifyingvariable parameter. Multiple keys can supplied character vector single string, keys separated commas. Use wildcard (*) allowed. stand Character string, format: \"DD.MM.YYYY\". retrieve data updated date. language Character string. Search terms, returned messages data descriptions German (\"de\") English (\"en\")?","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_cube — gen_cube","text":"tibble. Non-data contents data cube object saved metadata attribute data frame.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_cube.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_cube — gen_cube","text":"","code":"if (FALSE) { # \\dontrun{ gen_cube(\"47414BJ002\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_download_job — gen_download_job","title":"gen_download_job — gen_download_job","text":"gen_download_job","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_download_job — gen_download_job","text":"","code":"gen_download_job( name, database = c(\"genesis\", \"regio\"), area = c(\"all\", \"public\", \"user\"), compress = FALSE, language = Sys.getenv(\"RESTATIS_LANG\"), all_character = TRUE )"},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_download_job — gen_download_job","text":"name Character string. job code retrieved using gen_list_jobs(). database Character string. Indicator GENESIS ('genesis') regionalstatistik.de ('regio') database called. one database can addressed per function call. Default option 'genesis'. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. compress Boolean. empty rows columns discarded? Default FALSE. language Character string. Defines decimal mark grouping mark integers represented based European (e.g.: '100,5', '200.000,5') American ('100.5', '200,000.5') system. Defaults 'Sys.getenv(\"RESTATIS_LANG\")'. all_character Boolean. variables imported 'character' variables? Avoids fuzzy data type conversions leading zeros special characters. Defaults TRUE.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_download_job — gen_download_job","text":"Returns data.frame table content","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_download_job.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_download_job — gen_download_job","text":"","code":"if (FALSE) { # \\dontrun{ gen_download_job(\"21311-00-01-1_123456789\", \"regio\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":null,"dir":"Reference","previous_headings":"","what":"General Search for Objects Through GENESIS — gen_find","title":"General Search for Objects Through GENESIS — gen_find","text":"Function search databases GENESIS, Zensus 2022 regionalstatistik.de. similar usage search function GENESIS main page (https://www-genesis.destatis.de/genesis/online). search query, \"UND\" (German word '', also written \"und\" \"&\") well \"ODER\" (German word '', also written \"oder\" \"|\") can included logically combined. Furthermore, wildcards possible including \"*\". one word included term string, '' used automatically combine different words. Important note: Time-series treated cubes GENESIS regionalstatistik.de, longer distinguished. want find specific object clear code find function, need specify object type search object types.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"General Search for Objects Through GENESIS — gen_find","text":"","code":"gen_find( term = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"all\", \"tables\", \"statistics\", \"variables\", \"cubes\"), detailed = FALSE, ordering = TRUE, error.ignore = TRUE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"General Search for Objects Through GENESIS — gen_find","text":"term character string maximum character length, word limit five words. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. ordering logical. Indicator function return output iteration ordered first based fact searched term appearing title object secondly estimator number variables object. Default option 'TRUE'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'TRUE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"General Search for Objects Through GENESIS — gen_find","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_find.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"General Search for Objects Through GENESIS — gen_find","text":"","code":"if (FALSE) { # \\dontrun{ # Find objects related to \"bus\" in GENESIS object <- gen_find(term = \"bus\") # Find tables related to \"bus\" in GENESIS and return a unordered detailed output object <- gen_find(term = \"bus\", detailed = TRUE, ordering = FALSE) # Find tables related to \"Autos\" or \"Corona\" in GENESIS and return a unordered detailed output object <- gen_find(term = \"autos ODER corona\", detailed = TRUE, ordering = FALSE) #' # Find tables related to \"Autos\" and \"Corona\" in GENESIS and return a unordered detailed output object <- gen_find(term = \"autos UND corona\", detailed = TRUE, ordering = FALSE) } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_list_jobs — gen_list_jobs","title":"gen_list_jobs — gen_list_jobs","text":"Function list current jobs connected given user GENESIS regionalstatistik.de database. Important note: function also possible use searchcriterion parameter selection parameter, making possible filter job list based 'type','time','status' 'code'. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_list_jobs — gen_list_jobs","text":"","code":"gen_list_jobs( database = c(\"genesis\", \"regio\"), sortcriterion = c(\"type\", \"time\", \"status\", \"code\"), flat = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_list_jobs — gen_list_jobs","text":"database Character string. Indicator 'genesis' 'regionalstatistik.de' database called. Default option 'genesis'. sortcriterion Character string. Indicator output sorted 'type','time','status' 'code'. parameter API call . default 'type'. flat Boolean. function return list jobs metadata ('FALSE') just flat data.frame ('TRUE')? Defaults FALSE. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_list_jobs — gen_list_jobs","text":"list data.frame (see parameter 'flat') current jobs user.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_list_jobs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_list_jobs — gen_list_jobs","text":"","code":"if (FALSE) { # \\dontrun{ gen_list_jobs(\"regio\", flat = TRUE) } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_logincheck — gen_logincheck","title":"gen_logincheck — gen_logincheck","text":"Function check login possible certain database.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_logincheck — gen_logincheck","text":"","code":"gen_logincheck(database, verbose = FALSE)"},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_logincheck — gen_logincheck","text":"database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. one database can addressed per function call. Default option 'genesis'. verbose Boolean. case success, message printed? Defaults FALSE.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_logincheck — gen_logincheck","text":"Leads informative error message login check failed returns FALSE invisibly. Invisibly returns TRUE otherwise.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_logincheck.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_logincheck — gen_logincheck","text":"","code":"if (FALSE) { # \\dontrun{ gen_logincheck(\"zensus\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata — gen_metadata","title":"gen_metadata — gen_metadata","text":"Search Meta-Information Types Objects","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata — gen_metadata","text":"","code":"gen_metadata( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"cube\", \"statistic\", \"table\", \"variable\", \"value\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata — gen_metadata","text":"code String maximum length 15 characters database object (GENESIS, regionalstatistik.de, Zensus 2022). one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specifying specific object type object want meta data . default option - need specify object type. Hint: functions 'restatis' often return information object 'Type'. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata — gen_metadata","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata — gen_metadata","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the table with the code \"11111\" object <- gen_metadata(code = \"11111\", category = \"table\", database = \"genesis\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_cube — gen_metadata_cube","title":"gen_metadata_cube — gen_metadata_cube","text":"Function search meta information specific cube. Usable GENESIS regionalstatistik.de.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_cube — gen_metadata_cube","text":"","code":"gen_metadata_cube( code = NULL, database = c(\"all\", \"genesis\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_cube — gen_metadata_cube","text":"code character string maximum length 15 characters. Code GENESIS regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_cube — gen_metadata_cube","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_cube.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_cube — gen_metadata_cube","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the cube with the code \"11111KE001\" object <- gen_metadata_cube(code = \"11111KE001\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_statistic — gen_metadata_statistic","title":"gen_metadata_statistic — gen_metadata_statistic","text":"Function search meta information specific statistic.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_statistic — gen_metadata_statistic","text":"","code":"gen_metadata_statistic( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_statistic — gen_metadata_statistic","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_statistic — gen_metadata_statistic","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_statistic.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_statistic — gen_metadata_statistic","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the statistic with the code \"12411\" object <- gen_metadata_stats(code = \"12411\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_table — gen_metadata_table","title":"gen_metadata_table — gen_metadata_table","text":"Function search meta information specific table.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_table — gen_metadata_table","text":"","code":"gen_metadata_table( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_table — gen_metadata_table","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_table — gen_metadata_table","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_table.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_table — gen_metadata_table","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the table with the code \"11111\" object <- gen_metadata_tab(code = \"11111\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_value — gen_metadata_value","title":"gen_metadata_value — gen_metadata_value","text":"Function search meta information specific value.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_value — gen_metadata_value","text":"","code":"gen_metadata_value( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_value — gen_metadata_value","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_value — gen_metadata_value","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_value.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_value — gen_metadata_value","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the value with the code \"LEDIG\" object <- gen_metadata_val(code = \"LEDIG\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_metadata_variable — gen_metadata_variable","title":"gen_metadata_variable — gen_metadata_variable","text":"Function search meta information specific variable.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_metadata_variable — gen_metadata_variable","text":"","code":"gen_metadata_variable( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), error.ignore = FALSE, verbose = TRUE, raw = FALSE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_metadata_variable — gen_metadata_variable","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. raw Boolean. non-parsed API response returned? Default option 'FALSE'. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_metadata_variable — gen_metadata_variable","text":"list recalled elements API. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_metadata_variable.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_metadata_variable — gen_metadata_variable","text":"","code":"if (FALSE) { # \\dontrun{ # Find meta-information of the variable with the code \"FAMSTD\" object <- gen_metadata_var(code = \"FAMSTD\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_modified_data — gen_modified_data","title":"gen_modified_data — gen_modified_data","text":"Function check updates, changes, new objects based specific date.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_modified_data — gen_modified_data","text":"","code":"gen_modified_data( code = \"\", database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), type = c(\"all\", \"tables\", \"statistics\", \"statisticsUpdates\"), date = c(\"now\", \"week_before\", \"month_before\", \"year_before\"), verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_modified_data — gen_modified_data","text":"code character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. type Character string. Specific GENESIS regionalstatistik.de object types: 'tables', 'statistics', 'statisticsUpdates'. Specific Zensus 2022 object types: 'tables' 'statistics'. types specific one database can used together '', default. date Character string. Specific date used last update upload time include object return. Default option 'now', uses current date system. Alternative options 'week_before', using current date system minus 7 days, 'month_before', using current date system minus 4 weeks, 'year_before', using current date system minus 52 weeks. Additionally, possible fill specific date format 'DD.MM.YYYY'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_modified_data — gen_modified_data","text":"list recalled elements API. Always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_modified_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_modified_data — gen_modified_data","text":"","code":"if (FALSE) { # \\dontrun{ # Find objects which were modified last_week object <- gen_modified_data(date = \"week_before\") # Find tables that were new from 31.03.2020 object <- gen_modified_data(type = \"tables\", date = \"31.03.2020\") # Find objects related to the topic \"Bevölkerung\" (Code: '12*') which were new today object <- gen_modified_data(code = \"12*\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_objects2stat — gen_objects2stat","title":"gen_objects2stat — gen_objects2stat","text":"Function find objects related statistic","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_objects2stat — gen_objects2stat","text":"","code":"gen_objects2stat( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"tables\", \"variables\", \"cubes\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_objects2stat — gen_objects2stat","text":"code Character string maximum length 6 characters (15 characters 'cubes' used category). Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_objects2stat — gen_objects2stat","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2stat.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_objects2stat — gen_objects2stat","text":"","code":"if (FALSE) { # \\dontrun{ # Find cubes from the statistic with the code \"21111\" with a detailed return object <- gen_objects2stat(code = \"21111\", category = \"cubes\", detailed = T) # Find all object types from the statistic with the code \"12411\" object <- gen_objects2stat(code = \"12411\") # Default of detailed-parameter is FALSE, and default of the # category-parameter is to include all object types. } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_objects2var — gen_objects2var","title":"gen_objects2var — gen_objects2var","text":"Function find objects related variable","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_objects2var — gen_objects2var","text":"","code":"gen_objects2var( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), category = c(\"tables\", \"statistics\", \"cubes\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_objects2var — gen_objects2var","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. category Character string. Specify specific GENESIS/regionalstatistik.de object types ('tables', 'statistics' 'cubes') specific Zensus 2022 object types ('tables' 'statistics'). types specific one database can used together. Default option use types possible specific database. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_objects2var — gen_objects2var","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_objects2var.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_objects2var — gen_objects2var","text":"","code":"if (FALSE) { # \\dontrun{ # Find Tables for Variable \"Kreise\" and return detailed output object <- gen_objects2var(code = \"Kreise\", category = \"tables\", detailed = T) # Find everything for Variable \"GES\" object <- gen_objects2var(code = \"GES\") # Default of detailed-parameter is FALSE, and default of the # category-parameter is to include all object types. } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_search_vars — gen_search_vars","title":"gen_search_vars — gen_search_vars","text":"Function search specific variables","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_search_vars — gen_search_vars","text":"","code":"gen_search_vars( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_search_vars — gen_search_vars","text":"code Character string maximum length 6 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_search_vars — gen_search_vars","text":"list recalled elements API. Always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_search_vars.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_search_vars — gen_search_vars","text":"","code":"if (FALSE) { # \\dontrun{ # Find a specific variable \"GES\" in Genesis object <- gen_search_vars(\"GES\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_signs — gen_signs","title":"gen_signs — gen_signs","text":"Function list currently used special signs (e.g., 0, *, X, (), p, ...) meaning GENESIS, Zensus 2022 /regionalstatistik.de.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_signs — gen_signs","text":"","code":"gen_signs(database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), ...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_signs — gen_signs","text":"database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_signs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_signs — gen_signs","text":"list current used special signs.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_table — gen_table","title":"gen_table — gen_table","text":"Download table data GENESIS, Zensus 2022 regionalstatistik.de databases","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_table — gen_table","text":"","code":"gen_table(name, ...)"},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_table — gen_table","text":"name Character string. Name/code table. Use wildcards (*) possible. ... Optional parameters passed Genesis API call: area Character string. area table stored. Possible values: \"public\": table public catalogue \"user\": table user's account \"\": compress Boolean. empty rows columns discarded? transpose Boolean. Reshape table \"wide\" \"long\" format. startyear,endyear Four-digit integers. retrieve data years. regionalvariable Character string. Code regional variable whose value specified regionalkey filter results. regionalkey Character string. One regional keys. Multiple values can supplied character vector single string, regional keys separated commas. Use wildcard (*) allowed. classifyingvariable1,classifyingvariable2 ,classifyingvariable3 Character string. Code subject classification (SK-Merkmal) selection means corresponding classifyingkey parameter applied. classifyingkey1,classifyingkey2,classifyingkey3 Character string. One values subject classification (e.g. \"WZ93012\"). Applied corresponding classifyingvariable parameter. Multiple keys can supplied character vector single string, keys separated commas. Use wildcard (*) allowed. stand Character string, format: \"DD.MM.YYYY\". retrieve data updated date. language Search terms, returned messages data descriptions German (\"de\") English (\"en\")? job Boolean. Indicate whether job created (available 'Zensus' database).) all_character Boolean. variables imported 'character' variables? Avoids fuzzy data type conversions leading zeros special characters. Defaults TRUE.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_table — gen_table","text":"tibble.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_table.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_table — gen_table","text":"","code":"if (FALSE) { # \\dontrun{ gen_table(\"21311-0001\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_update_evas.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_update_evas — gen_update_evas","title":"gen_update_evas — gen_update_evas","text":"Function web scrape EVAS numbers EVAS website save .rda file. Takes parameters.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_update_evas.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_update_evas — gen_update_evas","text":"","code":"gen_update_evas()"},{"path":"https://correlaid.github.io/restatis/reference/gen_update_evas.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_update_evas — gen_update_evas","text":"updated .rda file containing latest EVAS numbers","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_val2var — gen_val2var","title":"gen_val2var — gen_val2var","text":"Function extract possible values variable. Values continuous variables extractable, function returns warning message case.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_val2var — gen_val2var","text":"","code":"gen_val2var( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), sortcriterion = c(\"code\", \"content\"), error.ignore = TRUE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_val2var — gen_val2var","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator values function stop error occurs object request found produce token response. Default option 'TRUE', prevents function stop even variable explanation (often case numerical variables). verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_val2var — gen_val2var","text":"list recalled elements API. Always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_val2var — gen_val2var","text":"","code":"if (FALSE) { # \\dontrun{ # Find the values of the variable \"DLAND\" object <- gen_val2var(code = \"DLAND\") } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_val2var2stat — gen_val2var2stat","title":"gen_val2var2stat — gen_val2var2stat","text":"Get values variables statistic. Values continuous variables extracted, function returns warning message.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_val2var2stat — gen_val2var2stat","text":"","code":"gen_val2var2stat( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore.var = FALSE, error.ignore.val = TRUE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_val2var2stat — gen_val2var2stat","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore.var Boolean. Indicator variables function stop error occurs object request found produce token response. Default option 'FALSE'. error.ignore.val Boolean. Indicator values function stop error occurs object request found produce token response. Default option 'TRUE', prevents function stop even variable explanation (often case numerical variables). verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_val2var2stat — gen_val2var2stat","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_val2var2stat.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_val2var2stat — gen_val2var2stat","text":"","code":"if (FALSE) { # \\dontrun{ # Find the values of variables in a specific statistic with # the code \"21111\" and a detailed description of the variables object <- gen_val2var2stat(code = \"21111\", detailed = TRUE) } # }"},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":null,"dir":"Reference","previous_headings":"","what":"gen_var2stat — gen_var2stat","title":"gen_var2stat — gen_var2stat","text":"Function generate variables statistics","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"gen_var2stat — gen_var2stat","text":"","code":"gen_var2stat( code = NULL, database = c(\"all\", \"genesis\", \"zensus\", \"regio\"), area = c(\"all\", \"public\", \"user\"), detailed = FALSE, sortcriterion = c(\"code\", \"content\"), error.ignore = FALSE, verbose = TRUE, ... )"},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"gen_var2stat — gen_var2stat","text":"code Character string maximum length 15 characters. Code GENESIS, Zensus 2022 regionalstatistik.de object. one code per iteration. database Character string. Indicator GENESIS ('genesis'), Zensus 2022 ('zensus') regionalstatistik.de ('regio') database called. Default option ''. area Character string. Indicator area database results called. general, '' appropriate solution. Default option ''. used 'statistics'. detailed Boolean. Indicator function return detailed output iteration including object-related information shortened output including code object title. Default option 'FALSE'. sortcriterion Character string. Indicator output sorted 'code' 'content'. parameter API call . default 'code'. error.ignore Boolean. Indicator function stop error occurs object request found produce token response. Default option 'FALSE'. verbose Boolean. Indicator output function include detailed messages warnings. Default option 'TRUE'. Set parameter 'FALSE' suppress additional messages warnings. ... Additional parameters API call. parameters affecting call , processing. details see vignette(\"additional_parameter\").","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"gen_var2stat — gen_var2stat","text":"list recalled elements API. Based 'detailed' parameter contains less information, always includes code object, title, type object. done facilitate processing data. Attributes added data.frame describing search configuration returned output.","code":""},{"path":"https://correlaid.github.io/restatis/reference/gen_var2stat.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"gen_var2stat — gen_var2stat","text":"","code":"if (FALSE) { # \\dontrun{ # Find the variables of the statistic with the code \"12411\" # with a detailed output object <- gen_var2stat(code = \"12411\", detailed = T) } # }"},{"path":"https://correlaid.github.io/restatis/reference/ggsub.html","id":null,"dir":"Reference","previous_headings":"","what":"ggsub — ggsub","title":"ggsub — ggsub","text":"ggsub","code":""},{"path":"https://correlaid.github.io/restatis/reference/ggsub.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ggsub — ggsub","text":"","code":"ggsub(x)"},{"path":"https://correlaid.github.io/restatis/reference/ggsub.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ggsub — ggsub","text":"x Element subset $Content","code":""},{"path":"https://correlaid.github.io/restatis/reference/insert_and_save_credentials.html","id":null,"dir":"Reference","previous_headings":"","what":"insert_and_save_credentials — insert_and_save_credentials","title":"insert_and_save_credentials — insert_and_save_credentials","text":"insert_and_save_credentials","code":""},{"path":"https://correlaid.github.io/restatis/reference/insert_and_save_credentials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"insert_and_save_credentials — insert_and_save_credentials","text":"","code":"insert_and_save_credentials(database)"},{"path":"https://correlaid.github.io/restatis/reference/insert_and_save_credentials.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"insert_and_save_credentials — insert_and_save_credentials","text":"database database specify credentials ","code":""},{"path":"https://correlaid.github.io/restatis/reference/is_cube_metadata_header.html","id":null,"dir":"Reference","previous_headings":"","what":"is_cube_metadata_header — is_cube_metadata_header","title":"is_cube_metadata_header — is_cube_metadata_header","text":"is_cube_metadata_header","code":""},{"path":"https://correlaid.github.io/restatis/reference/is_cube_metadata_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"is_cube_metadata_header — is_cube_metadata_header","text":"","code":"is_cube_metadata_header(lines)"},{"path":"https://correlaid.github.io/restatis/reference/is_cube_metadata_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"is_cube_metadata_header — is_cube_metadata_header","text":"lines Lines check header","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":null,"dir":"Reference","previous_headings":"","what":"logincheck_http_error — logincheck_http_error","title":"logincheck_http_error — logincheck_http_error","text":"logincheck_http_error","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"logincheck_http_error — logincheck_http_error","text":"","code":"logincheck_http_error(database, verbose)"},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"logincheck_http_error — logincheck_http_error","text":"database user input 'gen_logincheck' verbose Boolean. function message case success?","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_http_error.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"logincheck_http_error — logincheck_http_error","text":"Informative error/warning messages + invisibly TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":null,"dir":"Reference","previous_headings":"","what":"logincheck_stop_or_warn — logincheck_stop_or_warn","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"logincheck_stop_or_warn","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"","code":"logincheck_stop_or_warn(response, error, verbose, database)"},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"response HTTP response object error Boolean. function warn throw error? verbose Boolean. function message case success? database database check run ","code":""},{"path":"https://correlaid.github.io/restatis/reference/logincheck_stop_or_warn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"logincheck_stop_or_warn — logincheck_stop_or_warn","text":"case failure warns errors. Invisibly returns TRUE (success) FALSE (failure)","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_regionalkey.html","id":null,"dir":"Reference","previous_headings":"","what":"param_check_regionalkey — param_check_regionalkey","title":"param_check_regionalkey — param_check_regionalkey","text":"param_check_regionalkey","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_regionalkey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"param_check_regionalkey — param_check_regionalkey","text":"","code":"param_check_regionalkey(regionalkey)"},{"path":"https://correlaid.github.io/restatis/reference/param_check_regionalkey.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"param_check_regionalkey — param_check_regionalkey","text":"regionalkey Regional key","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_year.html","id":null,"dir":"Reference","previous_headings":"","what":"param_check_year — param_check_year","title":"param_check_year — param_check_year","text":"param_check_year","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_check_year.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"param_check_year — param_check_year","text":"","code":"param_check_year(year)"},{"path":"https://correlaid.github.io/restatis/reference/param_check_year.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"param_check_year — param_check_year","text":"year Year parameter value","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_collapse_vec.html","id":null,"dir":"Reference","previous_headings":"","what":"param_collapse_vec — param_collapse_vec","title":"param_collapse_vec — param_collapse_vec","text":"param_collapse_vec","code":""},{"path":"https://correlaid.github.io/restatis/reference/param_collapse_vec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"param_collapse_vec — param_collapse_vec","text":"","code":"param_collapse_vec(vec)"},{"path":"https://correlaid.github.io/restatis/reference/param_collapse_vec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"param_collapse_vec — param_collapse_vec","text":"vec Vector collapsed","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube — read_cube","title":"read_cube — read_cube","text":"read_cube","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube — read_cube","text":"","code":"read_cube(resp)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube — read_cube","text":"resp API response object resulting call 'data/cubefile'","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_block.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube_block — read_cube_block","title":"read_cube_block — read_cube_block","text":"read_cube_block","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_block.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube_block — read_cube_block","text":"","code":"read_cube_block(lines)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube_block.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube_block — read_cube_block","text":"lines Lines read header","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_data_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube_data_lines — read_cube_data_lines","title":"read_cube_data_lines — read_cube_data_lines","text":"read_cube_data_lines","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_data_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube_data_lines — read_cube_data_lines","text":"","code":"read_cube_data_lines(lines, col_names)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube_data_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube_data_lines — read_cube_data_lines","text":"lines Lines read data col_names Specify column names","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_metadata_header.html","id":null,"dir":"Reference","previous_headings":"","what":"read_cube_metadata_header — read_cube_metadata_header","title":"read_cube_metadata_header — read_cube_metadata_header","text":"read_cube_metadata_header","code":""},{"path":"https://correlaid.github.io/restatis/reference/read_cube_metadata_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read_cube_metadata_header — read_cube_metadata_header","text":"","code":"read_cube_metadata_header(line, rename_dups = TRUE)"},{"path":"https://correlaid.github.io/restatis/reference/read_cube_metadata_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read_cube_metadata_header — read_cube_metadata_header","text":"line Line read rename_dups Rename duplicates?","code":""},{"path":"https://correlaid.github.io/restatis/reference/rename_cube_data_columns.html","id":null,"dir":"Reference","previous_headings":"","what":"rename_cube_data_columns — rename_cube_data_columns","title":"rename_cube_data_columns — rename_cube_data_columns","text":"rename_cube_data_columns","code":""},{"path":"https://correlaid.github.io/restatis/reference/rename_cube_data_columns.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"rename_cube_data_columns — rename_cube_data_columns","text":"","code":"rename_cube_data_columns(cube)"},{"path":"https://correlaid.github.io/restatis/reference/rename_cube_data_columns.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"rename_cube_data_columns — rename_cube_data_columns","text":"cube cube object rename columns ","code":""},{"path":"https://correlaid.github.io/restatis/reference/resp_check_data.html","id":null,"dir":"Reference","previous_headings":"","what":"resp_check_data — resp_check_data","title":"resp_check_data — resp_check_data","text":"resp_check_data","code":""},{"path":"https://correlaid.github.io/restatis/reference/resp_check_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"resp_check_data — resp_check_data","text":"","code":"resp_check_data(resp)"},{"path":"https://correlaid.github.io/restatis/reference/resp_check_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"resp_check_data — resp_check_data","text":"resp Response object","code":""},{"path":"https://correlaid.github.io/restatis/reference/restatis-package.html","id":null,"dir":"Reference","previous_headings":"","what":"restatis: 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) — restatis-package","title":"restatis: 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) — restatis-package","text":"RESTful API wrapper accessing GENESIS database German Federal Statistical Office (Destatis) well Census Database database Germany's regional statistics. Supports data search functions, credential management, result caching, handling remote background jobs large datasets.","code":""},{"path":[]},{"path":"https://correlaid.github.io/restatis/reference/restatis-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"restatis: 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) — restatis-package","text":"Maintainer: Yannik Buhl ybuhl@posteo.de Authors: Zoran Kovacevic (ORCID) Dorian Le Jeune Long Nguyen long.nguyen@uni-bielefeld.de (ORCID) Johannes Ritter ritter.johannes@gmail.com","code":""},{"path":"https://correlaid.github.io/restatis/reference/return_table_object.html","id":null,"dir":"Reference","previous_headings":"","what":"return_table_object — return_table_object","title":"return_table_object — return_table_object","text":"return_table_object","code":""},{"path":"https://correlaid.github.io/restatis/reference/return_table_object.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"return_table_object — return_table_object","text":"","code":"return_table_object(response, response_type, language, all_character)"},{"path":"https://correlaid.github.io/restatis/reference/return_table_object.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"return_table_object — return_table_object","text":"response Response object response_type Response type language Language locale all_character Read variables character?","code":""},{"path":"https://correlaid.github.io/restatis/reference/rev_database_function.html","id":null,"dir":"Reference","previous_headings":"","what":"rev_database_function — rev_database_function","title":"rev_database_function — rev_database_function","text":"rev_database_function","code":""},{"path":"https://correlaid.github.io/restatis/reference/rev_database_function.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"rev_database_function — rev_database_function","text":"","code":"rev_database_function(input)"},{"path":"https://correlaid.github.io/restatis/reference/rev_database_function.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"rev_database_function — rev_database_function","text":"input Input test database name","code":""},{"path":"https://correlaid.github.io/restatis/reference/spezifisch_create.html","id":null,"dir":"Reference","previous_headings":"","what":"spezifisch_create — spezifisch_create","title":"spezifisch_create — spezifisch_create","text":"spezifisch_create","code":""},{"path":"https://correlaid.github.io/restatis/reference/spezifisch_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"spezifisch_create — spezifisch_create","text":"","code":"spezifisch_create(x)"},{"path":"https://correlaid.github.io/restatis/reference/spezifisch_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"spezifisch_create — spezifisch_create","text":"x Element extract $Spezifisch ","code":""},{"path":"https://correlaid.github.io/restatis/reference/split_cube.html","id":null,"dir":"Reference","previous_headings":"","what":"split_cube — split_cube","title":"split_cube — split_cube","text":"split_cube","code":""},{"path":"https://correlaid.github.io/restatis/reference/split_cube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"split_cube — split_cube","text":"","code":"split_cube(lines)"},{"path":"https://correlaid.github.io/restatis/reference/split_cube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"split_cube — split_cube","text":"lines Lines split cube","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_database_function.html","id":null,"dir":"Reference","previous_headings":"","what":"test_database_function — test_database_function","title":"test_database_function — test_database_function","text":"test_database_function","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_database_function.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_database_function — test_database_function","text":"","code":"test_database_function(input, error.input, text)"},{"path":"https://correlaid.github.io/restatis/reference/test_database_function.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_database_function — test_database_function","text":"input Input test database name error.input Indicator error.ignore text Indicator verbose","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error — test_if_error","title":"test_if_error — test_if_error","text":"test_if_error","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error — test_if_error","text":"","code":"test_if_error(input, para, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error — test_if_error","text":"input Response object para Parameter TRUE/FALSE verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_find.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error_find — test_if_error_find","title":"test_if_error_find — test_if_error_find","text":"test_if_error_find","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_find.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error_find — test_if_error_find","text":"","code":"test_if_error_find(input, para, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_find.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error_find — test_if_error_find","text":"input Response object para Parameter TRUE/FALSE verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_light.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error_light — test_if_error_light","title":"test_if_error_light — test_if_error_light","text":"test_if_error_light","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_light.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error_light — test_if_error_light","text":"","code":"test_if_error_light(input, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_light.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error_light — test_if_error_light","text":"input Response object verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_variables.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_error_variables — test_if_error_variables","title":"test_if_error_variables — test_if_error_variables","text":"test_if_error_variables","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_variables.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_error_variables — test_if_error_variables","text":"","code":"test_if_error_variables(input, para)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_error_variables.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_error_variables — test_if_error_variables","text":"input Response object para Parameter TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_json.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_json — test_if_json","title":"test_if_json — test_if_json","text":"test_if_json","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_json.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_json — test_if_json","text":"","code":"test_if_json(input)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_json.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_json — test_if_json","text":"input Response object","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_okay.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_okay — test_if_okay","title":"test_if_okay — test_if_okay","text":"test_if_okay","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_okay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_okay — test_if_okay","text":"","code":"test_if_okay(input)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_okay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_okay — test_if_okay","text":"input Response object","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_process_further.html","id":null,"dir":"Reference","previous_headings":"","what":"test_if_process_further — test_if_process_further","title":"test_if_process_further — test_if_process_further","text":"test_if_process_further","code":""},{"path":"https://correlaid.github.io/restatis/reference/test_if_process_further.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"test_if_process_further — test_if_process_further","text":"","code":"test_if_process_further(input, para, verbose = NULL)"},{"path":"https://correlaid.github.io/restatis/reference/test_if_process_further.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"test_if_process_further — test_if_process_further","text":"input Response object para Parameter TRUE/FALSE verbose Verbose TRUE/FALSE","code":""},{"path":"https://correlaid.github.io/restatis/reference/titel_search.html","id":null,"dir":"Reference","previous_headings":"","what":"titel_search — titel_search","title":"titel_search — titel_search","text":"titel_search","code":""},{"path":"https://correlaid.github.io/restatis/reference/titel_search.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"titel_search — titel_search","text":"","code":"titel_search(x, term, text)"},{"path":"https://correlaid.github.io/restatis/reference/titel_search.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"titel_search — titel_search","text":"x Element extract $Content term Search term text Indicator verbose","code":""},{"path":"https://correlaid.github.io/restatis/news/index.html","id":"restatis-020","dir":"Changelog","previous_headings":"","what":"restatis 0.2.0","title":"restatis 0.2.0","text":"CRAN release: 2024-07-25 Added support regionalstatistik.de Zensus 2022 database Massively improved handling ‘jobs’ (e.g., adding gen_download_job()) Added helper functions gen_logincheck() Rewrote functions background","code":""},{"path":"https://correlaid.github.io/restatis/news/index.html","id":"restatis-010","dir":"Changelog","previous_headings":"","what":"restatis 0.1.0","title":"restatis 0.1.0","text":"CRAN release: 2023-06-30 Initial CRAN submission.","code":""}]