Package: mutualinf
Type: Package
Title: Computation and Decomposition of the Mutual Information Index
Version: 2.0.4
Date: 2025-07-28
Authors@R: c(person("Cristian", "Angulo-Gonzalez", email = "cristian_world@hotmail.cl", role = c("aut", "cre")),
              person("Rafael", "Fuentealba-Chaura", email = "rafael.fuentealba97@gmail.com", role = "aut"),
              person("Ricardo", "Mora", email = "ricmora@eco.uc3m.es", role = "aut"),
              person("Julio", "Rojas-Mora", email = "julio.rojas@uct.cl", role = "aut"),
              person("FONDECYT/ANID Project 11170583", role = "fnd"),
              person("MCIN/AEI/10.13039/501100011033 (Project no. PID2019-108576RB-I00)", role = "fnd"),
              person("UCT VIP Project FEQUIP2019-INRN-03", role = "fnd"))
Maintainer: Cristian Angulo-Gonzalez <cristian_world@hotmail.cl>
Description: 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.
License: GPL-3
Imports: Rcpp (>= 1.0.13), data.table, parallel, runner, stats,
LinkingTo: Rcpp, RcppArmadillo
Encoding: UTF-8
LazyData: true
URL: https://github.com/RafaelFuentealbaC/mutualinf
BugReports: https://github.com/RafaelFuentealbaC/mutualinf/issues
Depends: R (>= 2.10)
Collate: 'Data_Source.R' 'get_internal_data.R' 'get_contribution.R'
        'M_value.R' 'M.R' 'get_general_contribution.R'
        'get_proportion.R' 'M_within.R' 'M_within_inv.R'
        'RcppExports.R' 'globals.R' 'mutual.R' 'prepare_data.R'
RoxygenNote: 7.3.2
Repository: https://rafaelfuentealbac.r-universe.dev
Date/Publication: 2025-08-07 13:52:31 UTC
RemoteUrl: https://github.com/rafaelfuentealbac/mutualinf
RemoteRef: HEAD
RemoteSha: 85993ac14f9e46455868d0eccbdf0fa616738fc5
NeedsCompilation: yes
Packaged: 2026-07-06 10:38:01 UTC; root
Author: Cristian Angulo-Gonzalez [aut, cre],
  Rafael Fuentealba-Chaura [aut],
  Ricardo Mora [aut],
  Julio Rojas-Mora [aut],
  FONDECYT/ANID Project 11170583 [fnd],
  MCIN/AEI/10.13039/501100011033 (Project no. PID2019-108576RB-I00) [fnd],
  UCT VIP Project FEQUIP2019-INRN-03 [fnd]