ipumspy.noextract.read_noextract_codebook#

class ipumspy.noextract.read_noextract_codebook(collection)[source]#

A method to parse the codebooks for non-extractable IPUMS datasets that come with this package

Parameters:

collection (str) – A valid non-extractable IPUMS data collection (yrbss or nyts)

Raises:

ValueError – If an invalid or extractable IPUMS data collection is specified

Returns:

an ipumspy Codebook object

Return type:

Codebook