healthequal
An R package to Compute Summary Measures of Health Inequality
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
-
✓DOI references
Found 3 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Keywords
inequalities
measures
r
summary-statistics
Last synced: 6 months ago
·
JSON representation
Repository
An R package to Compute Summary Measures of Health Inequality
Basic Info
- Host: GitHub
- Owner: WHOequity
- License: agpl-3.0
- Language: R
- Default Branch: main
- Homepage: https://whoequity.github.io/healthequal/
- Size: 4.81 MB
Statistics
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 2
- Releases: 1
Topics
inequalities
measures
r
summary-statistics
Created almost 2 years ago
· Last pushed over 1 year ago
Metadata Files
Readme
Changelog
License
README.Rmd
--- output: github_document --- # healthequal - Calculating summary measures of inequality[](https://www.repostatus.org/#active) [](https://choosealicense.com/licenses/agpl-3.0/) [](https://github.com/WHOequity/healthequal/actions/workflows/R-CMD-check.yaml) [](https://CRAN.R-project.org/package=healthequal) ```{r, include = FALSE} knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "100%", message = FALSE ) library(healthequal) ``` The `healthequal` package provides computational tools for calculating 21 summary measures of health inequality. # Installation You can install the released version of healthequal from [CRAN](https://CRAN.R-project.org) with: ``` r install.packages("healthequal") ``` The development version can be installed from [GitHub](https://github.com/) with: ``` r # install.packages("remotes") remotes::install_github("WHOequity/healthequal") ``` ## Measures of health inequality included in `healthequal`: The following summary measures of health inequality are included in the `healthequal` package: ### Simple measures - Difference (`d`) - Ratio (`r`) ### Disproportionality measures (ordered dimensions) - Absolute concentration index (`aci`) - Relative concentration index (`rci`) ### Regression-based measures (ordered dimensions) - Slope index of inequality (`sii`) - Relative index of inequality (`rii`) ### Variance measures (non-ordered dimensions) - Between-group variance (`bgv`) - Between-group standard deviation (`bgsd`) - Coefficient of variation (`covar`) ### Mean difference measures (non-ordered dimensions) - Mean difference from mean - unweighted and weighted (`mdmu` and `mdmw`) - Mean difference from best-performing subgroup - unweighted and weighted (`mdbu` and `mdbw`) - Mean difference from reference subgroup - unweighted and weighted (`mdru` and `mdrw`) - Index of disparity - unweighted and weighted (`idisu` and `idisw`) ### Disproportionality measures (non-ordered dimensions) - Theil index (`ti`) - Mean log deviation (`mld`) ### Impact measures - Population attributable risk (`parisk`) - Population attributable fraction (`paf`) # Package data The `healthequal` package comes with sample data for users to be able to test the package functions. The `OrderedSample` and `NonorderedSample` data contain data disaggregated by economic status and subnational region, respectively, for a single indicator. ### Ordered and Nonordered data ``` r data(OrderedSample) head(OrderedSample) ``` ``` r data(NonorderedSample) head(NonorderedSample) ``` ### Disagregated data The `OrderedSampleMultipleind` and `OrderedSampleMultipleind` data contain disaggregated data by economic status and subnational region, respectively, for two indicators. ``` r data(OrderedSampleMultipleind) head(OrderedSampleMultipleind) ``` ``` r data(NonorderedSampleMultipleind) head(NonorderedSampleMultipleind) ``` ### More info on the datasets For information about the datasets, type the following commands, which will display the corresponding dataset help file: ``` r ?healthequal::OrderedSample ?healthequal::NonorderedSample ?healthequal::OrderedSampleMultipleind ?healthequal::NonorderedSampleMultipleind ?healthequal::IndividualSample ``` # References: Schlotheuber, A, Hosseinpoor, AR. Summary measures of health inequality: A review of existing measures and their application. Int J Environ Res Public Health. 2022;19(6):3697. [doi:10.3390/ijerph19063697](https://doi.org/10.3390/ijerph19063697)
Owner
- Login: WHOequity
- Kind: user
- Location: Geneva, Switzerland
- Company: World Health Organization
- Website: https://www.who.int/data/inequality-monitor
- Repositories: 12
- Profile: https://github.com/WHOequity
Monitoring health inequalities is key to achieving health equity
GitHub Events
Total
- Issues event: 2
- Watch event: 1
- Push event: 2
Last Year
- Issues event: 2
- Watch event: 1
- Push event: 2
Packages
- Total packages: 1
-
Total downloads:
- cran 230 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
cran.r-project.org: healthequal
Compute Summary Measures of Health Inequality
- Homepage: https://github.com/WHOequity/healthequal
- Documentation: http://cran.r-project.org/web/packages/healthequal/healthequal.pdf
- License: AGPL (≥ 3)
-
Latest release: 1.0.1
published about 1 year ago
Rankings
Dependent packages count: 27.8%
Dependent repos count: 35.7%
Average: 49.5%
Downloads: 84.9%
Maintainers (1)
Last synced:
6 months ago
Dependencies
.github/workflows/R-CMD-check.yaml
actions
- actions/checkout v4 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
.github/workflows/pkgdown.yaml
actions
- JamesIves/github-pages-deploy-action v4.5.0 composite
- actions/checkout v4 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml
actions
- actions/checkout v4 composite
- actions/upload-artifact v4 composite
- codecov/codecov-action v4.0.1 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION
cran
- R >= 3.5.0 depends
- dplyr * imports
- emmeans * imports
- marginaleffects * imports
- rlang * imports
- srvyr * imports
- survey * imports
- bookdown * suggests
- knitr * suggests
- rmarkdown * suggests
- sandwich * suggests
- spelling * suggests
- testthat >= 3.0.0 suggests
[](https://www.repostatus.org/#active)
[](https://choosealicense.com/licenses/agpl-3.0/)
[](https://github.com/WHOequity/healthequal/actions/workflows/R-CMD-check.yaml)
[](https://CRAN.R-project.org/package=healthequal)
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%",
message = FALSE
)
library(healthequal)
```
The `healthequal` package provides computational tools for calculating 21 summary measures of health inequality.
# Installation
You can install the released version of healthequal from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("healthequal")
```
The development version can be installed from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("WHOequity/healthequal")
```
## Measures of health inequality included in `healthequal`:
The following summary measures of health inequality are included in the `healthequal` package:
### Simple measures
- Difference (`d`)
- Ratio (`r`)
### Disproportionality measures (ordered dimensions)
- Absolute concentration index (`aci`)
- Relative concentration index (`rci`)
### Regression-based measures (ordered dimensions)
- Slope index of inequality (`sii`)
- Relative index of inequality (`rii`)
### Variance measures (non-ordered dimensions)
- Between-group variance (`bgv`)
- Between-group standard deviation (`bgsd`)
- Coefficient of variation (`covar`)
### Mean difference measures (non-ordered dimensions)
- Mean difference from mean - unweighted and weighted (`mdmu` and `mdmw`)
- Mean difference from best-performing subgroup - unweighted and weighted (`mdbu` and `mdbw`)
- Mean difference from reference subgroup - unweighted and weighted (`mdru` and `mdrw`)
- Index of disparity - unweighted and weighted (`idisu` and `idisw`)
### Disproportionality measures (non-ordered dimensions)
- Theil index (`ti`)
- Mean log deviation (`mld`)
### Impact measures
- Population attributable risk (`parisk`)
- Population attributable fraction (`paf`)
# Package data
The `healthequal` package comes with sample data for users to be able to test the package functions. The `OrderedSample` and `NonorderedSample` data contain data disaggregated by economic status and subnational region, respectively, for a single indicator.
### Ordered and Nonordered data
``` r
data(OrderedSample)
head(OrderedSample)
```
``` r
data(NonorderedSample)
head(NonorderedSample)
```
### Disagregated data
The `OrderedSampleMultipleind` and `OrderedSampleMultipleind` data contain disaggregated data by economic status and subnational region, respectively, for two indicators.
``` r
data(OrderedSampleMultipleind)
head(OrderedSampleMultipleind)
```
``` r
data(NonorderedSampleMultipleind)
head(NonorderedSampleMultipleind)
```
### More info on the datasets
For information about the datasets, type the following commands, which will display the corresponding dataset help file:
``` r
?healthequal::OrderedSample
?healthequal::NonorderedSample
?healthequal::OrderedSampleMultipleind
?healthequal::NonorderedSampleMultipleind
?healthequal::IndividualSample
```
# References:
Schlotheuber, A, Hosseinpoor, AR. Summary measures of health inequality: A review of existing measures and their application. Int J Environ Res Public Health. 2022;19(6):3697. [doi:10.3390/ijerph19063697](https://doi.org/10.3390/ijerph19063697)