Add pseudopeople logo to documentation homepage

docs/source/datasets/index.rst

@@ -71,7 +71,7 @@ The following simulant attributes are included in this dataset:
    * - Physical address street name
      - :code:`street_name`
      - 
-   * - Physical address unit
+   * - Physical address unit number
      - :code:`unit_number`
      - 
    * - Physical address city
@@ -111,7 +111,7 @@ Bureau field representatives across the country through both personal and teleph
 work activity and income, veteran status, school enrollment, contingent employment, worker displacement, job tenure, and more. To find out more
 about CPS, please visit the `CPS homepage <https://www.census.gov/programs-surveys/cps.html>`_. 
 
-The following simulant attributes are included in this dataset:
+The following simulant attributes are included in these datasets:
 
 .. list-table:: **Simulant attributes**
    :header-rows: 1
@@ -146,7 +146,7 @@ The following simulant attributes are included in this dataset:
    * - Physical address street name
      - :code:`street_name`
      - 
-   * - Physical address unit
+   * - Physical address unit number
      - :code:`unit_number`
      - 
    * - Physical address city
@@ -212,7 +212,7 @@ The following simulant attributes are included in this dataset:
    * - Physical address street name
      - :code:`street_name`
      - 
-   * - Physical address unit
+   * - Physical address unit number
      - :code:`unit_number`
      - 
    * - Physical address city
@@ -236,6 +236,47 @@ The following simulant attributes are included in this dataset:
 
 Social Security
 ---------------
+The Social Security Administration (SSA) is the US federal government agency that administers Social Security, the social insurance program
+that consists of retirement, disability and survivor benefits. To find out more about this program, visit the `SSA homepage <https://www.ssa.gov/about-ssa>`_.
+
+Pseudopeople can generate a simulated version of a subset of the administrative data that would be recorded by SSA. Currently, the simulated
+SSA data includes records of SSA creation and dates of death.
+
+The following simulant attributes are included in this dataset:
+
+.. list-table:: **Simulant attributes**
+   :header-rows: 1
+
+   * - Attribute Name
+     - Column Name
+     - Notes
+   * - Unique simulant ID
+     - simulant_id
+     - Not affected by noise functions; intended use is 'ground truth' for PRL tracking.  
+   * - First name
+     - :code:`first_name`
+     - 
+   * - Middle initial
+     - :code:`middle_initial`
+     - 
+   * - Last name
+     - :code:`last_name`
+     - 
+   * - Age
+     - :code:`age`  
+     - Rounded down to an integer.
+   * - Date of birth
+     - :code:`date_of_birth`
+     - Formatted as YYYY-MM-DD.
+   * - Social security number 
+     - :code:`ssn`
+     - 
+   * - Date of event
+     - :code:`event_date`
+     - Formatted as YYYY-MM-DD.  
+   * - Type of event
+     - :code:`event_type`
+     - Possible values are 'Creation' and 'Death'. 
 
 The Social Security Administration (SSA) is the US federal government agency that administers Social Security, the social insurance program
 that consists of retirement, disability and survivor benefits. To find out more about this program, visit the `SSA homepage <https://www.ssa.gov/about-ssa>`_.
@@ -283,6 +324,86 @@ The following simulant attributes are included in this dataset:
 Tax W-2 & 1099
 --------------
 
+The following simulant attributes are included in these datasets:
+
+.. list-table:: **Simulant attributes**
+   :header-rows: 1
+
+   * - Attribute Name
+     - Column Name
+     - Notes
+   * - Unique simulant ID
+     - simulant_id
+     - Not affected by noise functions; intended use is 'ground truth' for testing and validation. 
+   * - Household ID 
+     - :code:`household_id` 
+     - Not affected by noise functions; intended use is 'ground truth' for testing and validation.
+   * - First name
+     - :code:`first_name`
+     - 
+   * - Middle initial
+     - :code:`middle_initial`
+     - 
+   * - Last name
+     - :code:`last_name`
+     - 
+   * - Age
+     - :code:`age`  
+     - Rounded down to an integer.
+   * - Date of birth
+     - :code:`date_of_birth`
+     - Formatted as YYYY-MM-DD.
+   * - Mailing address street number
+     - :code:`mailing_address_street_number`
+     - 
+   * - Mailing address street name
+     - :code:`mailing_address_street_name`
+     - 
+   * - Mailing address unit number
+     - :code:`mailing_address_unit_number`
+     - 
+   * - Mailing address city
+     - :code:`mailing_address_city`    
+     - 
+   * - Mailing address state
+     - :code:`mailing_address_state`  
+     - 
+   * - Mailing address ZIP code
+     - :code:`mailing_address_zipcode`
+     - 
+   * - Social security number 
+     - :code:`ssn`
+     - 
+   * - Income 
+     - :code:`income`
+     - 
+   * - Employer ID 
+     - :code:`employer_id`
+     -  
+   * - Employer Name 
+     - :code:`employer_name`
+     - 
+   * - Employer street number
+     - :code:`employer_street_number`
+     - 
+   * - Employer street name
+     - :code:`employer_street_name`
+     - 
+   * - Employer unit number
+     - :code:`employer_unit_number`
+     - 
+   * - Employer city
+     - :code:`employer_city`    
+     - 
+   * - Employer state
+     - :code:`employer_state`  
+     - 
+   * - Employer ZIP code
+     - :code:`employer_zipcode`
+     - 
+   * - Type of tax form 
+     - :code:`tax_form`
+     - Possible values are 'W2' or '1099'.
 
 Tax 1040
 --------

docs/source/index.rst

@@ -2,6 +2,10 @@
 Pseudopeople
 ============
 
+
+.. image:: ../Pseudopeople-logo_FINAL_2023.04.11_psdppl-logo_blue-ombre.png
+
+
 Pseudopeople is a Python package that generates realistic simulated data about a
 fictional United States population, for use in testing record linkage (entity resolution)
 methods.