humanleague: humanleague

humanleagueR Documentation

humanleague

Description

R package for synthesising populations from aggregate and (optionally) seed data

Details

See README.md for detailed information and examples.

Overview

The package contains algorithms that use a number of different microsynthesis techniques:

  • Iterative Proportional Fitting (IPF), a la mipfp package

  • Quasirandom Integer Sampling (QIS) (no seed population) -

  • Quasirandom Integer Sampling of IPF (QISI): A combination of the two techniques whereby IPF solutions are used to sample an integer population.

The latter provides a bridge between deterministic reweighting and combinatorial optimisation, offering advantages of both techniques:

  • generates high-entropy integral populations

  • can be used to generate multiple populations for sensitivity analysis

  • is less sensitive than IPF to convergence issues when there are a high number of empty cells present in the seed

  • relatively fast computation time, though running time is linear in population

The algorithms:

  • support arbitrary dimensionality* for both the marginals and the seed.

  • produce statistical data to ascertain the likelihood/degeneracy of the population (where appropriate).

[* excluding the legacy functions retained for backward compatibility with version 1.0.1]

The package also contains the following utility functions:

  • a Sobol sequence generator -

  • functionality to convert fractional to nearest-integer marginals (in 1D). This can also be achieved in multiple dimensions by using the QISI algorithm.

  • functionality to 'flatten' a population into a table: this converts a multidimensional array containing the population count for each state into a table listing individuals and their characteristics.

Functions

flatten

ipf

prob2IntFreq

qis

qisi

sobolSequence

integerise

unitTest


humanleague documentation built on April 18, 2023, 1:09 a.m.