ipu_nr {ipfr} | R Documentation |
Iterative Proportional Updating (Newton-Raphson)
Description
List balancing similar to ipu
, but using the
Newton-Raphson approach to optimization. Created primarily as a point of
comparison for ipu
.
Usage
ipu_nr(
primary_seed,
primary_targets,
secondary_seed = NULL,
secondary_targets = NULL,
target_priority = 1e+07,
relative_gap = 0.01,
max_iterations = 100,
absolute_diff = 10,
weight_floor = 1e-05,
verbose = FALSE,
max_ratio = 10000,
min_ratio = 1e-04
)
Arguments
primary_seed |
In population synthesis or household survey expansion,
this would be the household seed table (each record would represent a
household). It could also be a trip table, where each row represents an
origin-destination pair. Must contain a |
primary_targets |
A |
secondary_seed |
Most commonly, if the primary_seed describes households, the
secondary seed table would describe a unique person with each row. Must
also contain the |
secondary_targets |
Same format as |
target_priority |
This argument controls how quickly each set of
targets is relaxed. In other words: how important it is to match the target
exactly. Defaults to
|
relative_gap |
After each iteration, the weights are compared to the
previous weights and the
the |
max_iterations |
maximum number of iterations to perform, even if
|
absolute_diff |
Upon completion, the For example, if if a target value was 2, and the expanded weights equaled 1, that's a 100 is only 1. Defaults to 10. |
weight_floor |
Minimum weight to allow in any cell to prevent zero weights. Set to .0001 by default. Should be arbitrarily small compared to your seed table weights. |
verbose |
Print iteration details and worst marginal stats upon
completion? Default |
max_ratio |
|
min_ratio |
|
Value
a named list
with the primary_seed
with weight, a
histogram of the weight distribution, and two comparison tables to aid in
reporting.