R Observatory: Metrics for mutualinf version 2.0.4

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

mutualinf

2.0.4

Computation and Decomposition of the Mutual Information Index

0packages depend

6.6Kdownloads / year

–test coverage

13/13checks pass

Overview

About

Maintained by Cristian Angulo-GonzalezFirst published 2021-07-1311 releasesCRAN page ↗GitHub ↗

The Mutual Information Index (M) introduced to social science literature by Theil and Finizza (1971) doi:10.1080/0022250X.1971.9989795 is a multigroup segregation measure that is highly decomposable and that according to Frankel and Volij (2011) doi:10.1016/j.jet.2010.10.008 and Mora and Ruiz-Castillo (2011) doi:10.1111/j.1467-9531.2011.01237.x satisfies the Strong Unit Decomposability and Strong Group Decomposability properties. This package allows computing and decomposing the total index value into its "between" and "within" terms. These last terms can also be decomposed into their contributions, either by group or unit characteristics. The factors that produce each "within" term can also be displayed at the user's request. The results can be computed considering a variable or sets of variables that define separate clusters.

Install

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

install.packages("mutualinf", 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("RafaelFuentealbaC/mutualinf")

Development version from RafaelFuentealbaC/mutualinf. 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-mutualinf

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

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-mutualinf

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-mutualinf

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 4.3 min · r-devel-windows-x86_64

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

5

Dependencies · direct

Check history

OK2026-08-05
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-04-22
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-04-18
13 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 1,552 wordsVignettesNopkgdown siteNoNEWSNoCode of conductNoContributing guideNo

Examples that run: 0%
Documented parameters: 100%
Return-value docs: 100%
References docs: 33%

Downloads

6.6K

CRAN downloads in the past year

Rank #6,777 · ~18/day · ~549/mo

Releases R versions

Daily download trend is not available in this view yet.

23330 days

1.2K90 days

6.6K1 year

Compare downloads with other packages →

Also on399 r2u14 autocran

Repository

GitHub ↗ rafaelfuentealbac/mutualinf

3Stars

3Forks

0Open issues

0Open PRs

6Releases

102Commits

5Contributors

102 commits · Last activity 2025-08-07

Stars over time

2025-06-18 · 32026-07-07 · 3

Repository practices

Upstream repositoryBeta

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

Checks run against github.com/rafaelfuentealbac/mutualinf on 2026-08-16.

Reproducibility and dev environment (1)

data-raw/

Docs source (1)

README.Rmd

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

5 external dependencies (excludes base and recommended)

Depends (1)

R >= 2.10

Imports (5)

Rcpp data.tableparallelrunnerstats

LinkingTo (2)

Rcpp RcppArmadillo

Suggests (0)

none

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Datasets

People & History

People (7)

Maintainer (1)

Cristian Angulo-Gonzalez

Author, Maintainer · added in 2.0.1

Authors (4)

Cristian Angulo-Gonzalez

Author, Maintainer · added in 2.0.1

Rafael Fuentealba-Chaura

Author

Ricardo Mora

Author

Julio Rojas-Mora

Author

Funders (3)

FONDECYT/ANID Project 11170583

Funder · added in 1.0.1

MCIN/AEI/10.13039/501100011033 (Project no. PID2019-108576RB-I00)

Funder · added in 1.1.2

UCT VIP Project FEQUIP2019-INRN-03

Funder · added in 1.0.1

Package Timeline

11 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
2.0.4Latest
2025-08-24 · current release · diff ↗
R
R 4.5.0 released · 2025-04-11
2.0.3
2025-01-19 · diff ↗
2.0.2
2025-01-18 · diff ↗
2.0.1
2025-01-16 · diff ↗
R
R 4.4.0 released · 2024-04-24
1.2.2
2024-02-02 · diff ↗
R
R 4.3.0 released · 2023-04-21
1.1.3
2023-03-27 · diff ↗
unarchivedReturned to CRAN
2023-03-27
archivedRemoved from CRAN
2023-03-17
email to the maintainer is undeliverable
R
R 4.2.0 released · 2022-04-22
1.1.2
2021-10-28 · diff ↗
1.1.1
2021-08-23 · diff ↗
1.1.0
2021-08-16 · diff ↗

Show 3 earlier events

1.0.1
2021-07-21 · diff ↗
1.0.0
2021-07-13
R
R 4.1.0 released · 2021-05-18

Package metadata

First published: 2021-07-13
Total releases: 11 / 5 yrs
License: GPL-3 OSI
Minimum R: ≥ 2.10
Bundled data: 234 KB / 3 files
Download size: 257 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("mutualinf")

Format

Angulo-Gonzalez, C., FONDECYT/ANID Project 11170583, MCIN/AEI/10.13039/501100011033 (Project no. PID2019-108576RB-I00), UCT VIP Project FEQUIP2019-INRN-03, Fuentealba-Chaura, R., Mora, R., & Rojas-Mora, J. (2025). mutualinf: Computation and Decomposition of the Mutual Information Index (Version 2.0.4) [Computer software]. https://doi.org/10.32614/CRAN.package.mutualinf

This is what citation() produces when a package has no citation file of its own. If it prints something else, use that.

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 mutualinf version 2.0.4 [Data set]. HJJB, LLC. Data release v2026-08-18. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-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 →