Returns the data_name dataset-level metadata key from a survey design
object or a data frame.
Details
Returns the stored data_name only. When the key is not set this function
returns NA_character_ even when survey_name, field_start, field_end,
and field_period are all set. It never composes a label from the other
keys. A design object restored from a file written by surveycore 1.1.0 or
earlier reports NA_character_ rather than failing.
See also
Other metadata:
classify_question_type(),
extract_dataset_metadata(),
extract_field_dates(),
extract_field_period(),
extract_higher_is(),
extract_metadata(),
extract_missing_codes(),
extract_question_preface(),
extract_reverse_coded(),
extract_sata(),
extract_survey_name(),
extract_universe(),
extract_val_labels(),
extract_var_extra(),
extract_var_label(),
extract_var_note(),
extract_vendor(),
infer_question_prefaces(),
set_data_name(),
set_dataset_metadata(),
set_field_dates(),
set_field_period(),
set_higher_is(),
set_missing_codes(),
set_question_preface(),
set_reverse_coded(),
set_sata(),
set_survey_name(),
set_universe(),
set_val_labels(),
set_var_extra(),
set_var_label(),
set_var_note(),
set_vendor(),
survey_metadata(),
survey_weighting_history()
Examples
df <- data.frame(id = 1:5, y = c(2, 4, 3, 5, 1), w = rep(1, 5))
df <- set_survey_name(df, "Example Attitudes Survey 2026")
# A set survey_name does not fill data_name.
extract_data_name(df)
#> [1] NA
df <- set_data_name(df, "Example (February-March 2026)")
extract_data_name(df)
#> [1] "Example (February-March 2026)"