Add new values to any fields of an IPUMS USA or CPS extract object. All
fields are optional, and if omitted, will be unchanged. Supplying a value
for fields that take a single value, such as description
and data_format
,
will replace the existing value with the supplied value.
To remove existing values from an extract, see remove_from_extract()
.
For an overview of ipumsr microdata API functionality, see
vignette("ipums-api", package = "ipumsr")
.
add_to_extract(extract, ...)
# S3 method for usa_extract
add_to_extract(
extract,
description = NULL,
samples = NULL,
variables = NULL,
data_format = NULL,
...
)
# S3 method for cps_extract
add_to_extract(
extract,
description = NULL,
samples = NULL,
variables = NULL,
data_format = NULL,
...
)
An ipums_extract
object.
Further arguments passed to methods.
Description of the extract.
Character vector of samples to add to the extract, if any. Use the USA sample ID values or the CPS sample ID values.
Character vector of variables to add to the extract, if any.
The desired format of the extract data file (one of "fixed_width", "csv", "stata", "spss", or "sas9").
A modified IPUMS USA or CPS extract object
If the supplied extract definition comes from a previously submitted extract, this function will reset the definition to an unsubmitted state.
Other ipums_api:
define_extract_cps()
,
define_extract_from_json()
,
define_extract_usa()
,
download_extract()
,
extract_list_to_tbl()
,
extract_tbl_to_list()
,
get_extract_info()
,
get_last_extract_info()
,
get_recent_extracts_info
,
ipums_data_collections()
,
is_extract_ready()
,
remove_from_extract()
,
save_extract_as_json()
,
set_ipums_api_key()
,
submit_extract()
,
wait_for_extract()
usa_extract <- define_extract_usa(
description = "USA example",
samples = "us2013a",
variables = "YEAR"
)
revised_usa_extract <- add_to_extract(
usa_extract,
description = "Revised USA extract",
samples = "us2014a"
)
revised_usa_extract
#> Unsubmitted IPUMS USA extract
#> Description: Revised USA extract
#> Samples: (2 total) us2013a, us2014a
#> Variables: (1 total) YEAR
cps_extract <- define_extract_cps(
description = "CPS example",
samples = "cps2019_03s",
variables = "YEAR"
)
revised_cps_extract <- add_to_extract(
cps_extract,
description = "Revised CPS extract",
samples = "cps2020_03s"
)
revised_cps_extract
#> Unsubmitted IPUMS CPS extract
#> Description: Revised CPS extract
#> Samples: (2 total) cps2019_03s, cps2020_03s
#> Variables: (1 total) YEAR