ipumspy.api.metadata.NhgisDataTableMetadata#

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

Class to request and store metadata for an IPUMS NHGIS data table

Parameters:
  • name (str) – Name of the NHGIS data table for which to retrieve metadata

  • dataset_name (str) – Name of the NHGIS dataset containing this data table

Attributes

collection

Name of an IPUMS data collection

description

Description of the data table

nhgis_code

The code identifying the data table in the extract (variables in the extract data will include column names prefixed with this code)

sequence

Order in which the data table will appear in the metadata API and extracts

supported_collections

Collections that support this metadata class

universe

The statistical population measured by this data table

variables

Dictionary containing variable descriptions and codes for the variables included in the data table

name

IPUMS data table name

dataset_name

Name of the dataset to which this data table belongs

Methods