| Title: | R Client for the Statistics Denmark Databank API |
|---|---|
| Description: | The purpose of the package is to enable an R function interface into the Statistics Denmark Databank API mainly for research purposes. The Statistics Denmark Databank API has four endpoints, see here for more information and testing the API in their console: <https://www.dst.dk/en/Statistik/brug-statistikken/muligheder-i-statistikbanken/api>. This package mimics the structure of the API and provides four main functions to match the functionality of the API endpoints. |
| Authors: | Valeri Voev |
| Maintainer: | Valeri Voev <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.2.0 |
| Built: | 2025-03-05 03:48:12 UTC |
| Source: | https://github.com/valerivoev/danstat |
Get data for a particular table and variable selection
get_data(table_id, variables, language = c("en", "da"))get_data(table_id, variables, language = c("en", "da"))
table_id |
Table identifier, e.g. "folk1a" |
variables |
A list with variable code-values pairs. Each code-values pair should be a named list with names "code" and "values".
If all values for a variable are desired, define |
language |
Language for the return object. Default = |
A data frame
# Get data from table "folk1c" for selected values of variables "ieland" and "køn" # and all time periods available. # The "ieland" variable is filtered for Denmark (id = 5000) and Bulgaria (id = 5128) # and the "køn" variable id filtered for Men (id = 1) and Women (id = 2). # The "tid" variable is unfiltered, i.e. selects all available time periods # See get_table_metadata(table_id = "folk1c", variables_only = TRUE) for variable codes and values. variables <- list(list(code = "ieland", values = c(5100, 5128)), list(code = "køn", values = c(1,2)), list(code = "tid", values = NA)) data <- get_data("folk1c", variables)# Get data from table "folk1c" for selected values of variables "ieland" and "køn" # and all time periods available. # The "ieland" variable is filtered for Denmark (id = 5000) and Bulgaria (id = 5128) # and the "køn" variable id filtered for Men (id = 1) and Women (id = 2). # The "tid" variable is unfiltered, i.e. selects all available time periods # See get_table_metadata(table_id = "folk1c", variables_only = TRUE) for variable codes and values. variables <- list(list(code = "ieland", values = c(5100, 5128)), list(code = "køn", values = c(1,2)), list(code = "tid", values = NA)) data <- get_data("folk1c", variables)
Get a list of subjects covered in the data bank
get_subjects( subjects = NULL, recursive = FALSE, include_tables = FALSE, language = c("en", "da") )get_subjects( subjects = NULL, recursive = FALSE, include_tables = FALSE, language = c("en", "da") )
subjects |
Provide specific subject id's to get subtopics. E.g. |
recursive |
Whether subtopics/tables will be retrieved all the way down the hierarchy. Otherwise, only the closest level under the provided subjects will be retrieved. Default = |
include_tables |
Whether the result should contain tables. Otherwise, only subjects are returned. Default = |
language |
Language for the return object. Default = |
A data frame
# Get all subjects all_subjects <- get_subjects() # Or get (sub)subjects for specific subjects some_subjects <- get_subjects(subjects = c("2", "3")) # Get all subject hierarchy for a given subject subject_with_hierarchy <- get_subjects(subjects = "2", recursive = TRUE)# Get all subjects all_subjects <- get_subjects() # Or get (sub)subjects for specific subjects some_subjects <- get_subjects(subjects = c("2", "3")) # Get all subject hierarchy for a given subject subject_with_hierarchy <- get_subjects(subjects = "2", recursive = TRUE)
Title
get_table_metadata(table_id, variables_only = FALSE, language = c("en", "da"))get_table_metadata(table_id, variables_only = FALSE, language = c("en", "da"))
table_id |
Table identifier, e.g. "folk1a" |
variables_only |
If |
language |
Language for the return object. Default = |
A list with information about the table, like documentation url, variable description, etc. If variables_only = TRUE, returns a data frame with variable information.
# Get table metadata for a given table table_meta <- get_table_metadata(table_id = "folk1c") # a list # Get only information about the variables in the table table_meta_vars <- get_table_metadata(table_id = "folk1c", variables_only = TRUE) # a data frame# Get table metadata for a given table table_meta <- get_table_metadata(table_id = "folk1c") # a list # Get only information about the variables in the table table_meta_vars <- get_table_metadata(table_id = "folk1c", variables_only = TRUE) # a data frame
Get a list of stables in the data bank
get_tables( subjects = NULL, pastdays = NA_integer_, include_inactive = FALSE, language = c("en", "da") )get_tables( subjects = NULL, pastdays = NA_integer_, include_inactive = FALSE, language = c("en", "da") )
subjects |
Provide specific subject id's to get subtopics. E.g. |
pastdays |
Return only tables which have been updated within this number of days |
include_inactive |
Whether to return tables that are no longer updated |
language |
Language for the return object. Default = |
A data frame
# Get all tables all_tables <- get_tables() # Or get tables for specific subjects some_tables <- get_tables(subjects = c("2", "3413")) # Get all tables updated within the past 3 days tables_past3days <- get_tables(pastdays = 3)# Get all tables all_tables <- get_tables() # Or get tables for specific subjects some_tables <- get_tables(subjects = c("2", "3413")) # Get all tables updated within the past 3 days tables_past3days <- get_tables(pastdays = 3)