ipumspy.api.NhgisDataset#

class ipumspy.api.NhgisDataset(name, data_tables, geog_levels, years=<factory>, breakdown_values=<factory>)[source]#

IPUMS dataset object to include in an AggregateDataExtract object.

Parameters:

  • name (str) – IPUMS dataset name

  • data_tables (List[str]) – IPUMS data tables to extract from this dataset

  • geog_levels (List[str]) – Geographic level(s) at which to obtain data for this dataset

  • years (Optional[List[str]]) – Years for which to obtain data for this dataset (use ['*'] to select all years)

  • breakdown_values (Optional[List[str]]) – Breakdown values to apply to this dataset

Attributes

name

IPUMS dataset name

data_tables

IPUMS data tables to extract from this dataset

geog_levels

Geographic level(s) at which to obtain data for this dataset

years

Years for which to obtain data for this dataset (use ['*'] to select all years)

breakdown_values

Breakdown values to apply to this dataset

Methods

__init__

build

Format dataset information for API Extract submission