Skip to content

Documentation tweaks for TST extent selection updates #104

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
renae-r merged 1 commit into from
Feb 26, 2025
Merged

Documentation tweaks for TST extent selection updates #104

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
2 changes: 1 addition & 1 deletion docs/source/change-log.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This project adheres to `Semantic Versioning`_.
-----

* The IPUMS API now supports geographic extent selection for NHGIS time series tables.
Accordingly, a `geographic_instances` attribute has been added to the
Accordingly, a ``geographic_instances`` attribute has been added to the
:py:class:`~ipumspy.api.metadata.TimeSeriesTableMetadata` class to store retrieved
geographic extent metadata for a given time series table.

Expand Down
3 changes: 2 additions & 1 deletion 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 @@ -232,7 +232,8 @@ a trailing 0):
.. tip::
You can see available extent selection API codes, if any, in the ``geographic_instances`` attribute of
a submitted :class:`DatasetMetadata <ipumspy.api.metadata.DatasetMetadata>` or
:class:`TimeSeriesTableMetadata <ipumspy.api.metadata.TimeSeriesTableMetadata>` object.
:class:`TimeSeriesTableMetadata <ipumspy.api.metadata.TimeSeriesTableMetadata>` object. The
``geog_levels`` attribute indicates whether a given geographic level supports extent selection.

Note that the selected extents are applied to all datasets and time series tables in an extract.
It is not possible to request different extents for different data sources in a single extract.
Expand Down
3 changes: 1 addition & 2 deletions src/ipumspy/api/extract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,8 +713,7 @@ def __init__(
description: short description of your extract
data_format: desired format of the extract data file. One of ``"csv_no_header"``, ``"csv_header"``, or ``"fixed_width"``.
geographic_extents: Geographic extents to use for all ``datasets`` and ``time_series_tables`` in the extract definition (for instance, to
to obtain data within a particular state). Note that geographic extent selection is only supported for geographies
that nest within states.
to obtain data within a particular state).
tst_layout: desired data layout for all ``time_series_tables`` in the extract definition.
One of ``"time_by_column_layout"`` (default), ``"time_by_row_layout"``, or ``"time_by_file_layout"``.
breakdown_and_data_type_layout: desired layout of any ``datasets`` that have multiple data types or breakdown values. Either
Expand Down
Loading