Skip to content

Commit

Permalink
describe distribution of hardship values in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed Sep 20, 2023
1 parent 1e7f7f7 commit 631f657
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: ushardship
Title: Hardship Index from United States Census Data
Version: 0.0.1.020
Version: 0.0.1.021
Authors@R:
person(given = "Mark",
family = "Padgham",
Expand Down
8 changes: 8 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,14 @@ https://data.cityofchicago.org/Health-Human-Services/Census-Data-Selected-socioe
as a table of the six metrics plus their conversion to a composite hardship
index.

Note that those Chicago data are ultimately transformed into a single rank for
each measured area, and so manifest a perfectly uniform distribution. In
contrast, the values returned by the `hs_hardship_index()` function are not
transformed, and so generally manifest highly skewed distributions. The
logarithm of these values will nevertheless generally be approximately normally
distributed. Accordingly, any statistical analyses of hardship values should
generally be applied to log-transformed versions of the values derived here.

## Access to Census Bureau Data

This package requires an API key for census.gov, which can be obtained from
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ Chicago](https://data.cityofchicago.org/Health-Human-Services/Census-Data-Select
as a table of the six metrics plus their conversion to a composite
hardship index.

Note that those Chicago data are ultimately transformed into a single
rank for each measured area, and so manifest a perfectly uniform
distribution. In contrast, the values returned by the
`hs_hardship_index()` function are not transformed, and so generally
manifest highly skewed distributions. The logarithm of these values will
nevertheless generally be approximately normally distributed.
Accordingly, any statistical analyses of hardship values should
generally be applied to log-transformed versions of the values derived
here.

## Access to Census Bureau Data

This package requires an API key for census.gov, which can be obtained
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"codeRepository": "https://github.com/UrbanAnalyst/us-hardship-index",
"issueTracker": "https://github.com/UrbanAnalyst/us-hardship-index/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.0.1.020",
"version": "0.0.1.021",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down

0 comments on commit 631f657

Please sign in to comment.