ipumspy.api.metadata.TimeSeriesTableMetadata#

class ipumspy.api.metadata.TimeSeriesTableMetadata(collection, name)[source]#

Class to request and store metadata for an IPUMS time series table.

Parameters:

collection (str) – IPUMS collection that contains time series tables
name (str) – Name of the time series table for which to retrieve metadata

Attributes

`description`	Description of the time series table
`geog_levels`	Dictionary containing names and descriptions for the geographic levels available for the time series table
`geographic_instances`	Dictionary containing names and descriptions for all valid geographic extents available for any year in the time series table
`geographic_integration`	The method by which the time series table aligns geographic units across time ("nominal" integration aligns units by name, disregarding changes in unit boundaries; "standardized" integration provides data from multiple times for a single census's geographic units)
`sequence`	Order in which the time series table will appear in the metadata API and extracts
`supported_collections`	Collections that support this metadata class
`time_series`	Dictionary containing names and descriptions for the individual time series available for the time series table
`years`	Dictionary containing information on the available data years for the time series table
`collection`	Name of an IPUMS data collection
`name`	IPUMS time series table name

Methods