gen_cube: Get the Data of a Cube From GENESIS

View source: R/gen_cube.R

gen_cubeR Documentation

Get the Data of a Cube From GENESIS

Description

Download a cube with data from GENESIS.

Usage

gen_cube(name, ...)

Arguments

name

Name of the data cube

...

Optional parameters passed on to the GENESIS API call:

area

a string. The area in which the table is stored. Possible values:

  • "public": cube in the public catalogue

  • "user": cube in the user's account

values

a logical. Should values be included?

metadata

a logical. Should metadata be included?

additionals

a logical. Should additional metadata be included?

contents

a string. Names of required statistical specifications

startyear,endyear

a number. Only retrieve data between these years.

timeslices

a number. Number of timeslices (cumulative to startyear or endyear)

regionalvariable

character. Code of the regional variable whose value is specified in regionalkey to filter the results.

regionalkey

character. One or more regional keys. Multiple values can be supplied as a character vector or as a single string, with the regional keys separated by commas. Use of wildcard (*) allowed.

classifyingvariable1,classifyingvariable2 ,classifyingvariable3

character. Code of the subject classification (SK-Merkmal) to which the selection by means of the corresponding classifyingkey parameter is to be applied.

classifyingkey1,classifyingkey2,classifyingkey3

character. One or more values of a subject classification (e.g. "WZ93012"). Applied to the corresponding classifyingvariable parameter. Multiple keys can be supplied as a character vector or as a single string, with the keys separated by commas. Use of wildcard (*) allowed.

stand

a string "DD.MM.YYYY". Only retrieve data updated after this #' date.

language

Search terms, returned messages and data descriptions in German ("de") or English ("en")?

Value

A tibble. Non-data contents of the data cube object are saved in the metadata attribute of the data frame.

Examples

## Not run: 
gen_cube("47414BJ002")

## End(Not run)


restatis documentation built on July 9, 2023, 5:31 p.m.