Set the Prose Field Period

Sets the field_period dataset-level metadata key — the field period written for display, such as "February-March 2026" — on a survey design object or a data frame.

Usage

set_field_period(x, period)

Arguments

x

A survey design object or data.frame.

period

character(1), non-NA, or NULL to delete the key. Omitting it is an error, not a deletion.

Value

The modified object, invisibly.

Details

A convenience wrapper for set_dataset_metadata(x, field_period = period).

The argument is named period because the function name already carries the field_ context; the stored key is field_period. This function never touches the two structured dates — use set_field_dates() for those.

On a data frame, deleting the key also removes the pre-1.2.0 dates attribute, so the deletion is idempotent and a later as_survey() call cannot restore the old value.

See also

Other metadata: classify_question_type(), extract_data_name(), 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_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_field_period(df, "February-March 2026")
extract_field_period(df)
#> [1] "February-March 2026"

d <- as_survey(df, weights = w)
d <- set_field_period(d, "Spring 2026")
extract_field_period(d)
#> [1] "Spring 2026"