ipumspy.api.metadata.NhgisDatasetMetadata#

class ipumspy.api.metadata.NhgisDatasetMetadata(name, collection='nhgis')[source]#

Class to request and store metadata for an IPUMS NHGIS dataset

Parameters:: name (str) – Name of an IPUMS NHGIS dataset

Attributes

`breakdowns`	Dictionary containing names, types, descriptions, and breakdown values for all breakdowns available for the dataset
`collection`	Name of an IPUMS data collection
`data_tables`	Dictionary containing names, codes, and descriptions for all data tables available for the dataset
`description`	Description of the dataset from IPUMS
`geog_levels`	Dictionary containing names, descriptions, and extent information for the geographic levels available for the dataset
`geographic_instances`	Dictionary containing names and descriptions for the geographic extents available for the dataset, if any
`group`	Group of datasets to which the dataset belongs
`has_multiple_data_types`	Logical indicating whether multiple data types exist for the dataset (e.g., estimates and margins of error)
`nhgis_id`	ID used in IPUMS files to reference the dataset
`sequence`	Order in which the dataset will appear in the metadata API and extracts
`supported_collections`	Collections that support this metadata class
`name`	IPUMS dataset name

Methods