ipumsr (version 0.5.2)

save_extract_as_json: Save an ipums_extract to disk as JSON

Description

Save an ipums_extract to a JSON-formatted file. For an overview of ipumsr microdata API functionality, see vignette("ipums-api", package = "ipumsr").

Usage

save_extract_as_json(extract, file)

Value

The file path where the extract definition was written, invisibly.

Arguments

extract

An ipums_extract object.

file

File path at which to write the JSON-formatted extract definition.

Details

Note that this function only saves out the properties of an extract that are required to submit a new extract request, namely, the description, data structure, data format, samples, variables, and collection.

See Also

Other ipums_api: add_to_extract(), 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(), set_ipums_api_key(), submit_extract(), wait_for_extract()

Examples

my_extract <- define_extract_usa("Example", "us2013a", "YEAR")

extract_json_path <- file.path(tempdir(), "usa_extract.json")
save_extract_as_json(my_extract, file = extract_json_path)

copy_of_my_extract <- define_extract_from_json(extract_json_path)

identical(my_extract, copy_of_my_extract)