catalogue_tables: Table catalogue

Description Usage Arguments Value Examples

View source: R/catalogue-misc.R

Description

Retrieves list of tables according to selection

Usage

1
2
3
4
5
6
7
catalogue_tables(
  selection,
  area = c("free", "user", "all"),
  pagelength = 100,
  language = getOption("genesis_language"),
  genesis = getOption("genesis")
)

Arguments

selection

String to filter for the code of the table(s) to be returned. Use of wildcard (*) possible.

area

Area in which the object is stored:

  • "free" = objects in the public catalogue

  • "user" = objects saved to "Meine Tabellen"

pagelength

Maximum number of results delivered

language

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

A default value can also be set to the global option genesis_language via options(), e.g. options(genesis_language = "de").

genesis

Which GENESIS database should be used?

One of: "destatis", "regionalstatistik", "bildungsmonitoring", "bayern", "nrw", "sachsen-anhalt".

A default value can also be set to the global option genesis via options(), e.g. options(genesis = "destatis"), so that genesis does not have to be specified in the function call.

Value

A data.frame (or tbl_df if tibble package is installed)

Examples

1
2
3
4
5
## Not run: 
options(genesis = "destatis")
catalogue_tables("124*")

## End(Not run)

long39ng/restatis documentation built on Feb. 5, 2022, 6:26 p.m.