ipumspy.api.metadata.IhgisDatasetMetadata#

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

Class to request and store metadata for an IPUMS IHGIS dataset

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

Attributes

`collection`	Name of an IPUMS data collection
`country`	Two-character abbreviation of the country
`country_label`	Name of the country
`coverage`	If available, an estimate of how complete the enumeration was
`data_table_count`	Number of data tables included in the dataset
`data_tables`	Dictionary containing names, codes, and descriptions for the data tables available for the dataset
`dataset_type`	Type of dataset (population, agricultural, or tabulated)
`de_jure_de_facto`	Whether the census counted people who reside in the country (including those who were absent on the census day) [de jure], or people who were present in the country on the census day (including visitors) [de facto].
`description`	Title of the census
`dwelling_definition`	Definition used by the census of what constitutes a distinct dwelling unit
`enumeration_forms`	Type of enumeration forms used to collect information
`enumeration_unit`	Types of entities (e.g., population, households, etc.) counted in the census
`fieldwork_period`	Time period during which enumeration took place
`fieldwork_type`	Methods used for enumeration, such as face-to-face interviews or online forms
`group_quarters_definition`	Definition used by the census of what constitutes group quarters
`household_definition`	Definition used by the census of how people are grouped into households
`reference_period`	Date of record; people who were residents of or present in the country as of this date were counted.
`sample`	If applicable, the proportion of the population included in the sample on which the data tables are based
`sequence`	Order in which the dataset will appear
`statistical_agency`	Name of the statistical agency that conducted the census
`supported_collections`	Collections that support this metadata class
`tabulation_geographies`	Dictionary containing names, codes, and descriptions for the tabulation geographies available for the dataset
`universe`	Description of the population that was included in the enumeration
`year`	Year the census was conducted
`name`	IPUMS IHGIS dataset name

Methods

__init__