The initial version only works with open data and recodes are only applied when the language is set explicitly. Example

x <- od_table("OGD_krebs_ext_KREBS_1")

x$recode$
  label_field("C-KRE_GESCHLECHT-0", "en", "SEX")$
  label_measure("F-KRE", "en", "NUMBER")$
  level("C-KRE_GESCHLECHT-0", "GESCHLECHT-1", "en", "MALE")

x$language <- "en"
x$tabulate("C-KRE_GESCHLECHT-0", "F-KRE")

The recodes shoud also work with API tables now

x <- sc_table(json_file = sc_example("population_timeseries.json"))

x$recode$
  label_field("C-BESC11-0", "en", "SEX")$
  label_measure("F-ISIS-1", "en", "PERSONS")$
  level("C-BESC11-0", "1", "en", "MALE")

x$tabulate("C-BESC11-0")

Also the line x$language <- "en" in the comment above is no longer necessary.

Recoding operations that should be supported

• rename fields
• rename measures
• rename levels
• reorder fields
• set total codes
• set visibility of levels

this now works

earnings <- od_table("OGD_veste309_Veste309_1")
earnings$recode$
  total_codes("C-A11-0", "A11-1")$
  total_codes("C-STAATS-0", "STAATS-9")$
  total_codes("C-VEBDL-0", "VEBDL-10")$
  total_codes("C-BESCHV-0", "BESCHV-1")

earnings$total_codes()

It might make more sense to set the visibility automatically via $total_codes() and replace the "drop totals" logic with a "drop invisibles" logic

It turns out we also need a way to import both languages (german and english) into one sc_table object. Currently, only one language can be specified in the factory functions

We could either add a new language option "both" for all factory functions or define a method which adds the missing language

x <- sc_example("accomodation") %>% sc_table(language = "en")
x$recode$add_language("de")

The $add_language() method would send a new api request and then use $recode$label_field(), $recode$label_measure() and $recode$level() to add the new labels.

In any case this requires an additional request against the /table endpoint or an (additional) request against /schema. The /schema version is probably faster, but certainly more complicated to implement.

The add_language() method has been added. It makes a request against /table, extracts only the labels and adds it to the object

pop <- sc_example("pop") %>% sc_table(language = "en")
pop$add_language("de")
pop
#> An object of class sc_table
#> 
#> Database    Population at the beginning of the quarter since 2002 
#> Measures    Number of persons 
#> Fields      Quarter, Age in single years <96>, Sex <2>, Commune <2383> (Province-District) 
#> 
#> Request     2021-08-30 08:01:02 
#> STATcubeR   0.2.5
pop$language <- "de"
pop
#> An object of class sc_table
#>
#> Database    Bevölkerung zu Quartalsbeginn ab 2002 
#> Measures    Anzahl der Personen 
#> Fields      Quartal, Alter in Einzeljahren, Geschlecht, Gemeinde (Vergröberung über Politischen Bezirk) 
#> 
#> Request     2021-08-30 08:01:02 
#> STATcubeR   0.2.5

Closing this because soon we will add some updates that are unrelated to the recoder class. The documentation of the new features is currently limited to the class reference which schuld be enough for now.