get_metadata

Display survey metadata on the console. This function is the shared implementation behind the print() methods of Survey, RotativePanelSurvey and PoolSurvey, which is why it writes with cat() rather than through the metasurvey.verbose-gated message helper.

Usage

get_metadata(self)

Arguments

self

Object of class Survey

Value

NULL (called for side effect: prints metadata to console).

See also

Other survey-objects: Survey, cat_design(), cat_design_type(), get_data(), has_design(), has_recipes(), has_steps(), is_baked(), set_data(), survey_empty(), survey_to_data_frame(), survey_to_datatable(), survey_to_tibble()

Examples

dt <- data.table::data.table(
  id = 1:5, age = c(25, 30, 45, 50, 60),
  w = rep(1, 5)
)
svy <- Survey$new(
  data = dt, edition = "2023", type = "ech",
  psu = NULL, engine = "data.table", weight = add_weight(annual = "w")
)
get_metadata(svy)
#> Type: ECH
#> Edition: 2023
#> Periodicity: Annual
#> Engine: data.table
#> Design: 
#>   Design: Not initialized (lazy initialization - will be created when needed)
#> 
#> Steps: None
#> Recipes: None