Add RMarkdown describing ipumsr R package

ipumsr/R/api-keys.R

@@ -0,0 +1,6 @@
+
+# api key needed to connect to ipums nhgis data
+apikey <- '59cba10d8a5da536fc06b59dd0e03dee980e4c999e4f373846adcc75'
+
+# api key need to connect to tidycensus
+census_api_key("0196454888e2441971be7360589dd0399e036978")

ipumsr/data/nhgis0083_csv/nhgis0083_csv/nhgis0083_ds255_20215_county_codebook.txt

@@ -0,0 +1,157 @@
+--------------------------------------------------------------------------------
+Codebook for NHGIS data file 'nhgis0083_ds255_20215_county'
+--------------------------------------------------------------------------------
+
+Contents
+    - Data Summary
+    - Data Dictionary
+    - Citation and Use
+
+Additional documentation on NHGIS data sources is available at: 
+    https://www.nhgis.org/documentation/tabular-data 
+
+--------------------------------------------------------------------------------
+Data Summary
+--------------------------------------------------------------------------------
+
+Year:             2017-2021
+Geographic level: County (by State)
+Dataset:          2021 American Community Survey: 5-Year Data [2017-2021, Tracts & Larger Areas]
+   NHGIS code:    2017_2021_ACS5b
+   NHGIS ID:      ds255
+Breakdown(s):     Geographic Component:
+                     Total area (00)
+Data type(s):     (E) Estimates
+                  (M) Margins of error
+
+Tables:
+
+1. Number of Earners in Family
+   Universe:    Families
+   Source code: B19122
+   NHGIS code:  AO8N
+
+--------------------------------------------------------------------------------
+Data Dictionary
+--------------------------------------------------------------------------------
+
+Context Fields 
+        GISJOIN:     GIS Join Match Code
+        YEAR:        Data File Year
+        STUSAB:      State/US-Abbreviation (USPS)
+        REGIONA:     Region Code
+        DIVISIONA:   Division Code
+        STATE:       State Name
+        STATEA:      State Code
+        COUNTY:      County Name
+        COUNTYA:     County Code
+        COUSUBA:     County Subdivision Code
+        PLACEA:      Place Code
+        TRACTA:      Census Tract Code
+        BLKGRP:      Block Group
+        CONCITA:     Consolidated City Code
+        AIANHHA:     American Indian Area/Alaska Native Area/Hawaiian Home Land Code
+        RES_ONLYA:   American Indian Area/Alaska Native Area (Reservation or Statistical Entity Only) Code
+        TRUSTA:      American Indian Area (Off-Reservation Trust Land Only)/Hawaiian Home Land Code
+        AIHHTLI:     American Indian/Hawaiian Home Land Trust Land Indicator
+        AITSA:       Tribal Subdivision/Remainder Code
+        ANRCA:       Alaska Native Regional Corporation Code
+        CBSAA:       Metropolitan Statistical Area/Micropolitan Statistical Area Code
+        CSAA:        Combined Statistical Area Code
+        METDIVA:     Metropolitan Division Code
+        NECTAA:      New England City and Town Area Code
+        CNECTAA:     Combined New England City and Town Area Code
+        NECTADIVA:   New England City and Town Area Division Code
+        UAA:         Urban Area Code
+        CDCURRA:     Congressional District (2019-2021, 116th Congress) Code
+        SLDUA:       State Legislative District (Upper Chamber) Code
+        SLDLA:       State Legislative District (Lower Chamber) Code
+        ZCTA5A:      5-Digit ZIP Code Tabulation Area Code
+        SUBMCDA:     Subminor Civil Division Code
+        SDELMA:      School District (Elementary)/Remainder Code
+        SDSECA:      School District (Secondary)/Remainder Code
+        SDUNIA:      School District (Unified)/Remainder Code
+        PCI:         Metropolitan/Micropolitan Principal City Indicator
+        PUMAA:       Public Use Microdata Area Code
+        GEO_ID:      Census Geographic Area Identifier
+        BTTRA:       Tribal Census Tract Code
+        BTBG:        Tribal Block Group
+        TL_GEO_ID:   TIGER/Line Shapefile Geographic Area Identifier
+
+Data Type (E):
+    Estimates
+
+        NAME_E:      Geographic Area Full Name
+
+    Table 1:     Number of Earners in Family
+    Universe:    Families
+    Source code: B19122
+    NHGIS code:  AO8N
+        AO8NE001:    Total
+        AO8NE002:    No earners
+        AO8NE003:    1 earner
+        AO8NE004:    2 earners
+        AO8NE005:    3 or more earners
+
+Data Type (M):
+    Margins of error
+
+        NAME_M:      Geographic Area Full Name
+
+    Table 1:     Number of Earners in Family
+    Universe:    Families
+    Source code: B19122
+    NHGIS code:  AO8N
+        AO8NM001:    Total
+        AO8NM002:    No earners
+        AO8NM003:    1 earner
+        AO8NM004:    2 earners
+        AO8NM005:    3 or more earners
+
+--------------------------------------------------------------------------------
+Citation and Use of NHGIS Data
+--------------------------------------------------------------------------------
+
+All persons are granted a limited license to use this documentation and the
+accompanying data, subject to the following conditions:
+
+* REDISTRIBUTION: You will not redistribute the data without permission.
+
+  You may publish a subset of the data to meet journal requirements for accessing 
+  data related to a particular publication. Contact us for permission for any other 
+  redistribution; we will consider requests for free and commercial redistribution.
+
+* CITATION: You will cite NHGIS appropriately.
+
+    * Publications and research reports employing NHGIS data (either tabular or GIS) 
+      should include the following citation:
+
+        Steven Manson, Jonathan Schroeder, David Van Riper, Katherine Knowles, Tracy Kugler, Finn Roberts, and Steven Ruggles.
+        IPUMS National Historical Geographic Information System: Version 18.0 
+        [dataset]. Minneapolis, MN: IPUMS. 2023.
+        http://doi.org/10.18128/D050.V18.0
+
+    * For policy briefs, online resources, or articles in the popular press, we 
+      recommend that you cite the use of NHGIS data as follows:
+
+        IPUMS NHGIS, University of Minnesota, www.nhgis.org.
+
+These terms of use are a legally binding agreement. You can use the data only in 
+accordance with these terms, and any other use is a violation of the agreement. 
+Violations may result in revocation of the agreement and prohibition from using other 
+IPUMS data. If IPUMS or our partners are harmed from your violation, you are 
+responsible for all damages, including reasonable attorney's fees and expenses.
+
+In addition, we request that users send us a copy of any publications, research
+reports, or educational material making use of the data or documentation.
+
+Send electronic material to: nhgis@umn.edu
+
+Printed matter should be sent to:
+
+    IPUMS NHGIS
+    Institute for Social Research and Data Innovation
+    University of Minnesota
+    50 Willey Hall
+    225 19th Ave S
+    Minneapolis, MN 55455