Skip to content
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.

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

Add documentation for dataset descriptions #69

Merged
merged 5 commits into from
Apr 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions docs/source/datasets/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _datasets_main:

========
Datasets
========
Here we cover the simulated datasets, which are analogous to 'real world' administrative records such as tax documents and census surveys, that users can generate using :code:`pseudopeople` to test their PRL methods.

.. contents::
:depth: 2
:local:
:backlinks: none


.. list-table:: **Types of Forms**
:header-rows: 1
:widths: 20

* - Name
* - | Decennial census
* - | American communities survey
* - | Current population survey
* - | Women, infants, and children survey
* - | Social security
* - | Tax W2 and 1099 forms
* - | Tax 1040 form

Decennial Census
----------------


Household Surveys: American Communities Survey and Current Population Survey
----------------------------------------------------------------------------
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The github repo can be found at: https://github.com/ihmeuw/pseudopeople
:maxdepth: 2

installation
datasets/index
noise_functions/index
tutorials/index
concepts/index
Expand Down