Add codebook files to ipums_list_files() output
#85
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since codebook files can be read by ipumsr, it makes sense to include them in the list of available files in a zipped extract. This is primarily useful for NHGIS, which provides zipped extracts by default.
Further, with expanded NHGIS extent selection options, it's more likely to produce extracts that don't actually contain any data (selecting an extent that does not apply for a given dataset is currently allowable by the IPUMS API). In these cases,
ipums_list_files()produces confusingly empty output if it does not include codebook files in the list. Importantly, the codebook files are particularly useful in this case, as they indicate if no data were available for the selected extents.This PR adds codebook files (
.txtfor NHGIS, and—for completeness—.xmlfor microdata) to the output ofipums_list_files()and also removes arguments to this function that were deprecated in v0.6.0.