Skip to content

Clarify metadata documentation #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robe2037 merged 1 commit into from
Mar 3, 2025
Merged

Clarify metadata documentation #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/source/ipums_api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,9 @@ IPUMS Metadata
Microdata Collections
*********************

.. note::
Currently, comprehensive IPUMS API metadata is only available for IPUMS NHGIS.
For microdata collections, only sample information is available. You can also obtain a dictionary
of sample codes with :py:meth:`.get_all_sample_info`.
Currently, comprehensive IPUMS API metadata is only available for IPUMS NHGIS.
For microdata collections, only sample information is available. You can obtain a dictionary
of sample codes with :py:meth:`.get_all_sample_info`.

Aggregate Data Collections
**************************
Expand Down
18 changes: 16 additions & 2 deletions docs/source/ipums_api/ipums_api_aggregate/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ single file using the ``breakdown_and_data_type_layout`` argument.
Dataset + Data Table Metadata
+++++++++++++++++++++++++++++

You can obtain a listing of datasets and data tables as well as detailed information about individual
datasets and data tables via the :ref:`IPUMS Metadata API <ipums-metadata>`.

Use the :class:`DatasetMetadata <ipumspy.api.metadata.DatasetMetadata>` data class to browse the available
specification options for a particular dataset and identify the codes to use when
requesting data from the API:
Expand Down Expand Up @@ -203,8 +206,12 @@ into separate files (by default, time is arranged across columns).
tst_layout="time_by_row_layout",
)

As with datasets and data tables, you can request metadata about the available specification options
for a specific time series table using the :class:`TimeSeriesTableMetadata <ipumspy.api.metadata.TimeSeriesTableMetadata>` class.
Time Series Table Metadata
++++++++++++++++++++++++++

As with datasets and data tables, you can request :ref:`metadata <ipums-metadata>` about the available specification options
for a specific time series table using the :class:`TimeSeriesTableMetadata <ipumspy.api.metadata.TimeSeriesTableMetadata>` class
with :py:meth:`.get_metadata`.

Geographic Extent Selection
---------------------------
Expand Down Expand Up @@ -254,6 +261,13 @@ simply by specifying their names:
shapefiles=["us_county_2021_tl2021", "us_county_2020_tl2020"]
)

Shapefile Metadata
++++++++++++++++++

You can access a listing of shapefile API codes and descriptions via the :ref:`IPUMS Metadata API <ipums-metadata>`
using :py:meth:`.get_metadata_catalog` with ``metadata_type="shapefiles"``. The IPUMS API does not provide
detailed metadata for individual shapefiles.

Multiple Data Sources
---------------------

Expand Down
Loading