microdata_create_extract
Submit an IPUMS microdata extract request by choosing collection, samples, variables, and output format; returns new extract number and status.
Instructions
Submit a new IPUMS microdata extract request. Specify the collection, samples, variables, and output format. Returns the new extract number and initial status. Once submitted, use microdata_extract_to_code to generate reproducible R or Python code for the extract.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| samples | No | Sample IDs to include | |
| version | No | API version (default: v2) | v2 |
| variables | No | Variables to include | |
| collection | Yes | IPUMS microdata collection (e.g. 'usa', 'cps') | |
| dataFormat | No | Output file format | |
| description | No | Human-readable description of this extract | |
| caseSelectWho | No | Who to select cases for | |
| dataStructure | No | Data structure specification |