Data

Tools

Indexes

Applications

Experiments

Open Source Science

us-hardship-index

National hardship index from US census data

https://github.com/urbananalyst/us-hardship-index

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

National hardship index from US census data

Basic Info
  • Host: GitHub
  • Owner: UrbanAnalyst
  • Language: R
  • Default Branch: main
  • Size: 52.7 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Codemeta

README.Rmd 

---
title: "US Hardship Index"
output:
  md_document:
    variant: markdown_github

  rmarkdown::html_vignette:
    self_contained: no
---



```{r opts, echo = FALSE}
knitr::opts_chunk$set (
    collapse = TRUE,
    warning = TRUE,
    message = TRUE,
    width = 120,
    comment = "#>",
    fig.retina = 2,
    fig.path = "README-"
)
```

[![R build
status](https://github.com/UrbanAnalyst/us-hardship-index/workflows/R-CMD-check/badge.svg)](https://github.com/UrbanAnalyst/us-hardship-index/actions?query=workflow%3AR-CMD-check)
[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)


# US Hardship Index

`us-hardship-index` is an R package for calculating a hardship index for
specified US states, using data from the US Census Bureau's *American Community
Survey*. It includes the single primary function `hs_hardship_index()`, which
accepts the two parameters of:

- "state" for the desired US state; and
- "year" for the desired year (with values available since 2010).

The index itself is calculated from the methodology of "*An Update on Urban
Hardship*," by Lisa M. Monteil, Richard P. Nathan, and David J. Wright (2004),
*The Nelson A. Rockefeller Institute of Goverment*. It is formed as a multiple
of the following six measures, each standardised to unit (or percentage)
scales:

- *occupancy*: Proportion of rooms with > 1 occupant per room;
- *poverty*: Proportion of households below poverty line;
- *unemployment*: Proportion of unemployed adults;
- *no_hs*: Proportion of population without highschool diploma
- *deps*:  Proportion of population who may be considered dependent; that is
  either under 18 or over 65
- *income*: Per-capita income

All variables are quantified such that lower values are better, except for
income. The hardship index is then simply the product of those six metrics,
again standardised to a unit (or percentage) scale. An example of the index in
action is provided by [the city of Chicago](
https://data.cityofchicago.org/Health-Human-Services/Census-Data-Selected-socioeconomic-indicators-in-C/kn9c-c2s2/data),
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
[the Census Bureau's website](https://api.census.gov/data/key_signup.html).
This key should be stored as an environment variable named `CENSUS_API_KEY`,
generally by specifying its value in the `~/.Renviron` file. Alternatively, the
key can be set with the [`tidycensus` function,
`census_api_key()`](https://walker-data.com/tidycensus/reference/census_api_key.html).

Owner

  • Name: Urban Analyst
  • Login: UrbanAnalyst
  • Kind: organization
  • Location: Germany

Platform for analysis and visualation of social equitability of urban systems

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "ushardship",
  "description": "Derives a Hardship Index from United States census data.",
  "name": "ushardship: Hardship Index from United States Census Data",
  "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.1.0.002",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.0 (2024-04-24)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Mark",
      "familyName": "Padgham",
      "email": "mark.padgham@email.com"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Mark",
      "familyName": "Padgham",
      "email": "mark.padgham@email.com"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "checkmate",
      "name": "checkmate",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=checkmate"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dplyr"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "geodist",
      "name": "geodist",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=geodist"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "memoise",
      "name": "memoise",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=memoise"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "tidycensus",
      "name": "tidycensus",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tidycensus"
    },
    "SystemRequirements": {}
  },
  "fileSize": "181.771KB",
  "readme": "https://github.com/UrbanAnalyst/us-hardship-index/blob/main/README.md",
  "contIntegration": "https://github.com/UrbanAnalyst/us-hardship-index/actions?query=workflow%3AR-CMD-check",
  "developmentStatus": "https://www.repostatus.org/#active"
}

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.hooks/description cran
DESCRIPTION cran