R Observatory: Metrics for healthequal version 1.0.1

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

healthequal

1.0.1Package record

Compute Summary Measures of Health Inequality

0packages depend

2.8Kdownloads / year

56.8%test coverage

13/13flavors OK

Overview

About

Maintained by Katherine KirkbyCRAN page ↗GitHub ↗Website ↗Issues ↗

Compute 21 summary measures of health inequality and its corresponding confidence intervals for ordered and non-ordered dimensions using disaggregated data. Measures for ordered dimensions (e.g., Slope Index of Inequality, Absolute Concentration Index) also accept individual and survey data.

Changes in 1.0.1

Bug fixes

Fix confidence interval simulation for non-ordered dimensions when using non-percentage indicators.
Remove row names for non-ordered dimensions with simulated confidence intervals.
Fix d to run without declared standard errors (se).
Fix d and r to select correct subgroup reference values for non-ordered dimensions with/without reference group.
Fix d and r to return positive results and ≥1 for data with non-ordered dimensions without reference group, respectively.
Fix scale of the reported se for sii.
Allow conf.level for sii and rii with aggregated data.
Use family=quasibinomial(logit) for sii and rii non-linear regression models.
Add example of the use of sii, rii, aci and rci with disaggregated (OrderedSample) data.
Add additional variable checks.
Add force option to all summary measures.

Show all changes in 1.0.1Hide the rest of the changes in 1.0.1

Remove requirement for declared scale variable for summary measures with simulated confidence intervals.
Drop creation of scaleval in rci.
Add se to all return data frames.

Text and formatting

Standardise formatting.
Add additional references and apply WHO reference style.
Edit summary measure descriptions.

From NEWS.md in the release

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("healthequal", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("WHOequity/healthequal")

Development version from WHOequity/healthequal. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-healthequal

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-healthequal

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-healthequal

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 3.4 min · r-oldrel-windows-x86_64

Status changes

OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 1.0.1

READMEYes · 350 wordsVignettesYes · 1 · dynamicNEWSYes · 100% structured · mentions 1.0.1Citation fileYes · software entry onlyWebsiteYes · pkgdown

Help pages: 26
Examples that run: 100%25 run in a plain check
Exported functions with examples: 100%
Documented parameters: 100%
Return-value docs: 100%
Help pages citing references: 81% with a bibliography file

Vignettes (1)

Introduction

How these are measured

Downloads

2.8K

CRAN downloads in the past year

Rank #16,388 · ~8/day · ~235/mo

Releases R versions

Daily download trend is not available in this view yet.

34430 days

75190 days

2.8K1 year

Compare downloads with other packages →

Also on73 r2u10 autocran

How downloads are counted

Repository

whoequity/healthequal ↗Account: WHOequity

3Stars

1Forks

2Open issues

0Open PRs

1Releases

72Commits

4Commit identities

inequalitiesmeasuressummary-statisticsr

License file reads as AGPL-3.0 · 72 commits · Last activity 2024-11-22 · 0% stars, 30d

Responsiveness

not measured

Stars over time

2025-06-09 · 22026-07-07 · 3

How these are measured

PracticesBeta

9 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/whoequity/healthequal on 2026-10-11.

Continuous integration (2)

GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (4)

README.Rmdpkgdown

GitHub Pages site last deployed 2024-11-22 · The repository has a site deploy workflow

pkgdown site last built 2024-11-22, before release 1.0.1 (2024-11-25)

Coverage (1)

Coverage reporting

CRAN release process (1)

cran-comments.md

Show all practicesHide 1 practice

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v3 (2026-09-26)

Dependencies

Declared dependencies

12 external dependencies (excludes base and recommended)

Installing healthequal adds 37 packages (20 with compiled code, 39 MB of source tarballs). Heaviest: stringi 11 MB, data.table 5.7 MB, srvyr 3.2 MB.

Depends (1)

R >= 3.5.0

Imports (6)

dplyr emmeans marginaleffects rlang srvyr survey

LinkingTo (0)

none

Suggests (6)

bookdown knitr rmarkdown sandwich spelling testthat (>= 3.0.0)

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

Datasets

People & History

People (5)

Katherine Kirkby

Author, Maintainer since 1.0.0 (2024)

Daniel A. Antiporta

Author

Ahmad Hosseinpoor

Author

Patricia Menéndez

Author

World Health Organization

Copyright holder

Releases (2)

Pick two releases to compare their code metrics.

R
R 4.6.0 released · 2026-04-24
R
R 4.5.0 released · 2025-04-11
1.0.1Latest
record
2024-11-25 · current release · diff ↗
1.0.0
record
2024-05-02
R
R 4.4.0 released · 2024-04-24

Package metadata

First published: 2024-05-02
Total releases: 2 / 2 yrs
License: AGPL (>= 3) OSI
Minimum R: ≥ 3.5.0
Bundled data: 128 KB / 5 files
Download size: 639 KB

Cite

Cite this package

Run in R for the authors' entry:

citation("healthequal")

The package provides a citation file, so citation() returns the authors' own entry.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for healthequal version 1.0.1 [Data set]. HJJB, LLC. Data release v2026-10-18. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-18, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →