Skip to contents

Applies per-country variant settings (e.g. fertility convergence, migration adjustments) from info_variants to the country objects stored inside a projection object. Must be called after create_projection_object and before project. Calling it a second time on the same object is blocked unless force = TRUE.

Usage

variants_loader(
  projection_object,
  country_info = base_data_list[[10]],
  force = FALSE
)

Arguments

projection_object

Projection_object; an unresolved projection object whose country objects will be modified by variant settings

country_info

Data frame; variant settings for each country, typically `base_data_list$info_variants` (default `base_data_list[[10]]`)

force

Logical, if TRUE loads a variant even if a variant has been already loaded. (default FALSE)

Value

The input projection_object with modified country_object_list.

See also

info_variants for a description of the variant settings table, create_projection_object to create the object passed here, project to run the projection after loading a variant. vignette("conducting-projections") for a full walkthrough.

Examples

p_object <- create_projection_object(name = "test")
#> 

#> Loading Algeria [>----------------------------------------------------------------------------------------] ETA 23s   1%
#> 

#> Loading Angola [=>----------------------------------------------------------------------------------------] ETA 23s   2%
#> 

#> Loading Azerbaijan [=>------------------------------------------------------------------------------------] ETA 25s   2%
#> 

#> Loading Argentina [==>------------------------------------------------------------------------------------] ETA 26s   3%
#> 

#> Loading Australia [==>------------------------------------------------------------------------------------] ETA 28s   3%
#> 

#> Loading Austria [===>-------------------------------------------------------------------------------------] ETA 31s   4%
#> 

#> Loading Bahamas [===>-------------------------------------------------------------------------------------] ETA 33s   4%
#> 

#> Loading Bahrain [===>-------------------------------------------------------------------------------------] ETA 32s   5%
#> 

#> Loading Bangladesh [====>---------------------------------------------------------------------------------] ETA 32s   5%
#> 

#> Loading Armenia [====>------------------------------------------------------------------------------------] ETA 33s   6%
#> 

#> Loading Barbados [=====>----------------------------------------------------------------------------------] ETA 33s   6%
#> 

#> Loading Belgium [=====>-----------------------------------------------------------------------------------] ETA 32s   7%
#> 

#> Loading Bhutan [======>-----------------------------------------------------------------------------------] ETA 32s   7%
#> 

#> Loading Bolivia [======>----------------------------------------------------------------------------------] ETA 31s   8%
#> 

#> Loading Bosnia and Herzegovina [=====>--------------------------------------------------------------------] ETA 32s   8%
#> 

#> Loading Botswana [=======>--------------------------------------------------------------------------------] ETA 32s   9%
#> 

#> Loading Brazil [========>---------------------------------------------------------------------------------] ETA 31s   9%
#> 

#> Loading Belize [========>---------------------------------------------------------------------------------] ETA 32s  10%
#> 

#> Loading Solomon Islands [=======>-------------------------------------------------------------------------] ETA 31s  10%
#> 

#> Loading Brunei [=========>--------------------------------------------------------------------------------] ETA 30s  11%
#> 

#> Loading Bulgaria [=========>------------------------------------------------------------------------------] ETA 30s  11%
#> 

#> Loading Myanmar [==========>------------------------------------------------------------------------------] ETA 30s  12%
#> 

#> Loading Burundi [==========>------------------------------------------------------------------------------] ETA 29s  12%
#> 

#> Loading Belarus [===========>-----------------------------------------------------------------------------] ETA 29s  13%
#> 

#> Loading Cambodia [===========>----------------------------------------------------------------------------] ETA 29s  13%
#> 

#> Loading Cameroon [===========>----------------------------------------------------------------------------] ETA 29s  14%
#> 

#> Loading Canada [============>-----------------------------------------------------------------------------] ETA 28s  14%
#> 

#> Loading Cape Verde [============>-------------------------------------------------------------------------] ETA 28s  15%
#> 

#> Loading Central African Republic [==========>-------------------------------------------------------------] ETA 28s  15%
#> 

#> Loading Sri Lanka [=============>-------------------------------------------------------------------------] ETA 28s  16%
#> 

#> Loading Chad [==============>-----------------------------------------------------------------------------] ETA 28s  16%
#> 

#> Loading Chile [==============>----------------------------------------------------------------------------] ETA 28s  17%
#> 

#> Loading China [===============>---------------------------------------------------------------------------] ETA 28s  17%
#> 

#> Loading China,  Taiwan Province of China [==========>-----------------------------------------------------] ETA 28s  18%
#> 

#> Loading Colombia [===============>------------------------------------------------------------------------] ETA 28s  18%
#> 

#> Loading Comoros [================>------------------------------------------------------------------------] ETA 28s  19%
#> 

#> Loading Mayotte [================>------------------------------------------------------------------------] ETA 28s  19%
#> 

#> Loading Congo [=================>-------------------------------------------------------------------------] ETA 28s  20%
#> 

#> Loading Congo,  Dem. Rep. [===============>---------------------------------------------------------------] ETA 27s  20%
#> 

#> Loading Costa Rica [=================>--------------------------------------------------------------------] ETA 27s  21%
#> 

#> Loading Croatia [==================>----------------------------------------------------------------------] ETA 27s  21%
#> 

#> Loading Cuba [===================>------------------------------------------------------------------------] ETA 27s  22%
#> 

#> Loading Cyprus [===================>----------------------------------------------------------------------] ETA 27s  22%
#> 

#> Loading Czechia [===================>---------------------------------------------------------------------] ETA 27s  23%
#> 

#> Loading Benin [====================>----------------------------------------------------------------------] ETA 26s  23%
#> 

#> Loading Denmark [====================>--------------------------------------------------------------------] ETA 26s  24%
#> 

#> Loading Dominican Republic [==================>-----------------------------------------------------------] ETA 26s  24%
#> 

#> Loading Ecuador [=====================>-------------------------------------------------------------------] ETA 26s  25%
#> 

#> Loading El Salvador [=====================>---------------------------------------------------------------] ETA 26s  25%
#> 

#> Loading Equatorial Guinea [===================>-----------------------------------------------------------] ETA 26s  26%
#> 

#> Loading Ethiopia [======================>-----------------------------------------------------------------] ETA 26s  26%
#> 

#> Loading Eritrea [=======================>-----------------------------------------------------------------] ETA 26s  27%
#> 

#> Loading Estonia [=======================>-----------------------------------------------------------------] ETA 25s  27%
#> 

#> Loading Fiji [=========================>------------------------------------------------------------------] ETA 25s  28%
#> 

#> Loading Finland [========================>----------------------------------------------------------------] ETA 25s  28%
#> 

#> Loading France [=========================>----------------------------------------------------------------] ETA 25s  29%
#> 

#> Loading French Guiana [=======================>-----------------------------------------------------------] ETA 25s  29%
#> 

#> Loading French Polynesia [=======================>--------------------------------------------------------] ETA 25s  30%
#> 

#> Loading Djibouti [==========================>-------------------------------------------------------------] ETA 24s  30%
#> 

#> Loading Gabon [===========================>---------------------------------------------------------------] ETA 24s  31%
#> 

#> Loading Georgia [===========================>-------------------------------------------------------------] ETA 24s  31%
#> 

#> Loading Gambia [============================>-------------------------------------------------------------] ETA 24s  32%
#> 

#> Loading Palestine [===========================>-----------------------------------------------------------] ETA 23s  32%
#> 

#> Loading Germany [============================>------------------------------------------------------------] ETA 23s  33%
#> 

#> Loading Ghana [=============================>-------------------------------------------------------------] ETA 23s  33%
#> 

#> Loading Kiribati [=============================>----------------------------------------------------------] ETA 23s  34%
#> 

#> Loading Greece [==============================>-----------------------------------------------------------] ETA 23s  34%
#> 

#> Loading Grenada [==============================>----------------------------------------------------------] ETA 23s  35%
#> 

#> Loading Guadeloupe [=============================>--------------------------------------------------------] ETA 23s  35%
#> 

#> Loading Guam [================================>-----------------------------------------------------------] ETA 22s  36%
#> 

#> Loading Guatemala [===============================>-------------------------------------------------------] ETA 22s  36%
#> 

#> Loading Guinea [================================>---------------------------------------------------------] ETA 22s  37%
#> 

#> Loading Guyana [=================================>--------------------------------------------------------] ETA 22s  37%
#> 

#> Loading Haiti [=================================>---------------------------------------------------------] ETA 22s  38%
#> 

#> Loading Honduras [=================================>------------------------------------------------------] ETA 21s  38%
#> 

#> Loading China,  Hong Kong SAR [============================>----------------------------------------------] ETA 21s  39%
#> 

#> Loading Hungary [==================================>------------------------------------------------------] ETA 21s  39%
#> 

#> Loading Iceland [==================================>------------------------------------------------------] ETA 21s  40%
#> 

#> Loading India [====================================>------------------------------------------------------] ETA 21s  40%
#> 

#> Loading Indonesia [==================================>----------------------------------------------------] ETA 21s  41%
#> 

#> Loading Iran [=====================================>------------------------------------------------------] ETA 20s  41%
#> 

#> Loading Iraq [=====================================>------------------------------------------------------] ETA 20s  42%
#> 

#> Loading Ireland [=====================================>---------------------------------------------------] ETA 20s  42%
#> 

#> Loading Israel [======================================>---------------------------------------------------] ETA 20s  43%
#> 

#> Loading Italy [======================================>----------------------------------------------------] ETA 20s  43%
#> 

#> Loading Ivory Coast [====================================>------------------------------------------------] ETA 20s  44%
#> 

#> Loading Jamaica [======================================>--------------------------------------------------] ETA 19s  44%
#> 

#> Loading Japan [========================================>--------------------------------------------------] ETA 19s  45%
#> 

#> Loading Kazakhstan [======================================>-----------------------------------------------] ETA 19s  45%
#> 

#> Loading Jordan [========================================>-------------------------------------------------] ETA 19s  46%
#> 

#> Loading Kenya [=========================================>-------------------------------------------------] ETA 18s  46%
#> 

#> Loading North Korea [=======================================>---------------------------------------------] ETA 18s  47%
#> 

#> Loading Republic of Korea [====================================>------------------------------------------] ETA 18s  47%
#> 

#> Loading Kosovo [==========================================>-----------------------------------------------] ETA 17s  48%
#> 

#> Loading Kuwait [==========================================>-----------------------------------------------] ETA 17s  48%
#> 

#> Loading Kyrgyzstan [=========================================>--------------------------------------------] ETA 17s  49%
#> 

#> Loading Laos [============================================>-----------------------------------------------] ETA 16s  49%
#> 

#> Loading Lebanon [===========================================>---------------------------------------------] ETA 16s  50%
#> 

#> Loading Lesotho [============================================>--------------------------------------------] ETA 16s  50%
#> 

#> Loading Latvia [=============================================>--------------------------------------------] ETA 15s  51%
#> 

#> Loading Liberia [=============================================>-------------------------------------------] ETA 15s  51%
#> 

#> Loading Libya [==============================================>--------------------------------------------] ETA 15s  52%
#> 

#> Loading Lithuania [============================================>------------------------------------------] ETA 15s  52%
#> 

#> Loading Luxembourg [============================================>-----------------------------------------] ETA 14s  53%
#> 

#> Loading Macao [===============================================>-------------------------------------------] ETA 14s  53%
#> 

#> Loading Madagascar [=============================================>----------------------------------------] ETA 14s  54%
#> 

#> Loading Malawi [================================================>-----------------------------------------] ETA 14s  54%
#> 

#> Loading Malaysia [===============================================>----------------------------------------] ETA 13s  55%
#> 

#> Loading Maldives [================================================>---------------------------------------] ETA 13s  55%
#> 

#> Loading Mali [==================================================>-----------------------------------------] ETA 13s  56%
#> 

#> Loading Malta [==================================================>----------------------------------------] ETA 13s  56%
#> 

#> Loading Martinique [================================================>-------------------------------------] ETA 12s  57%
#> 

#> Loading Mauritania [================================================>-------------------------------------] ETA 12s  57%
#> 

#> Loading Mauritius [=================================================>-------------------------------------] ETA 12s  58%
#> 

#> Loading Mexico [===================================================>--------------------------------------] ETA 12s  58%
#> 

#> Loading Mongolia [===================================================>------------------------------------] ETA 12s  59%
#> 

#> Loading Moldova [====================================================>------------------------------------] ETA 11s  59%
#> 

#> Loading Montenegro [==================================================>-----------------------------------] ETA 11s  60%
#> 

#> Loading Morocco [=====================================================>-----------------------------------] ETA 11s  60%
#> 

#> Loading Mozambique [===================================================>----------------------------------] ETA 11s  61%
#> 

#> Loading Oman [=======================================================>------------------------------------] ETA 10s  61%
#> 

#> Loading Namibia [======================================================>----------------------------------] ETA 10s  62%
#> 

#> Loading Nepal [========================================================>----------------------------------] ETA 10s  62%
#> 

#> Loading Netherlands [====================================================>--------------------------------] ETA 10s  63%
#> 

#> Loading Curacao [=======================================================>---------------------------------] ETA 10s  63%
#> 

#> Loading Aruba [=========================================================>---------------------------------] ETA  9s  64%
#> 

#> Loading New Caledonia [====================================================>------------------------------] ETA  9s  64%
#> 

#> Loading Vanuatu [=========================================================>-------------------------------] ETA  9s  65%
#> 

#> Loading New Zealand [======================================================>------------------------------] ETA  9s  65%
#> 

#> Loading Nicaragua [========================================================>------------------------------] ETA  9s  66%
#> 

#> Loading Niger [===========================================================>-------------------------------] ETA  9s  66%
#> 

#> Loading Nigeria [==========================================================>------------------------------] ETA  8s  67%
#> 

#> Loading Norway [===========================================================>------------------------------] ETA  8s  67%
#> 

#> Loading Micronesia [=========================================================>----------------------------] ETA  8s  68%
#> 

#> Loading Pakistan [===========================================================>----------------------------] ETA  8s  68%
#> 

#> Loading Panama [=============================================================>----------------------------] ETA  8s  69%
#> 

#> Loading Papua New Guinea [======================================================>-------------------------] ETA  8s  69%
#> 

#> Loading Paraguay [============================================================>---------------------------] ETA  7s  70%
#> 

#> Loading Peru [================================================================>---------------------------] ETA  7s  70%
#> 

#> Loading Philippines [===========================================================>-------------------------] ETA  7s  71%
#> 

#> Loading Poland [===============================================================>--------------------------] ETA  7s  71%
#> 

#> Loading Portugal [==============================================================>-------------------------] ETA  7s  72%
#> 

#> Loading Guinea-Bissau [===========================================================>-----------------------] ETA  7s  72%
#> 

#> Loading East Timor [=============================================================>------------------------] ETA  6s  73%
#> 

#> Loading Puerto Rico [=============================================================>-----------------------] ETA  6s  73%
#> 

#> Loading Qatar [==================================================================>------------------------] ETA  6s  74%
#> 

#> Loading Réunion [=================================================================>-----------------------] ETA  6s  74%
#> 

#> Loading Romania [=================================================================>-----------------------] ETA  6s  75%
#> 

#> Loading Russia [===================================================================>----------------------] ETA  6s  75%
#> 

#> Loading Rwanda [===================================================================>----------------------] ETA  6s  76%
#> 

#> Loading St. Lucia [=================================================================>---------------------] ETA  5s  76%
#> 

#> Loading Saint Vincent and the Grenadines [================================================>---------------] ETA  5s  77%
#> 

#> Loading Sao Tome & Principe [==========================================================>------------------] ETA  5s  77%
#> 

#> Loading Saudi Arabia [================================================================>-------------------] ETA  5s  78%
#> 

#> Loading Senegal [=====================================================================>-------------------] ETA  5s  78%
#> 

#> Loading Serbia [======================================================================>-------------------] ETA  5s  79%
#> 

#> Loading Seychelles [===================================================================>------------------] ETA  5s  79%
#> 

#> Loading Sierra Leone [==================================================================>-----------------] ETA  5s  80%
#> 

#> Loading Singapore [=====================================================================>-----------------] ETA  4s  80%
#> 

#> Loading Slovakia [======================================================================>-----------------] ETA  4s  81%
#> 

#> Loading Viet Nam [======================================================================>-----------------] ETA  4s  81%
#> 

#> Loading Slovenia [=======================================================================>----------------] ETA  4s  82%
#> 

#> Loading Somalia [========================================================================>----------------] ETA  4s  82%
#> 

#> Loading South Africa [====================================================================>---------------] ETA  4s  83%
#> 

#> Loading Zimbabwe [========================================================================>---------------] ETA  4s  83%
#> 

#> Loading Spain [===========================================================================>---------------] ETA  4s  84%
#> 

#> Loading South Sudan [======================================================================>--------------] ETA  3s  84%
#> 

#> Loading Sudan [============================================================================>--------------] ETA  3s  85%
#> 

#> Loading Western Sahara [=====================================================================>------------] ETA  3s  85%
#> 

#> Loading Suriname [==========================================================================>-------------] ETA  3s  86%
#> 

#> Loading Eswatini [===========================================================================>------------] ETA  3s  86%
#> 

#> Loading Sweden [=============================================================================>------------] ETA  3s  87%
#> 

#> Loading Switzerland [=========================================================================>-----------] ETA  3s  87%
#> 

#> Loading Syria [===============================================================================>-----------] ETA  3s  88%
#> 

#> Loading Tajikistan [===========================================================================>----------] ETA  2s  88%
#> 

#> Loading Thailand [=============================================================================>----------] ETA  2s  89%
#> 

#> Loading Togo [=================================================================================>----------] ETA  2s  89%
#> 

#> Loading Tonga [================================================================================>----------] ETA  2s  90%
#> 

#> Loading Trinidad & Tobago [======================================================================>--------] ETA  2s  90%
#> 

#> Loading United Arab Emirates [====================================================================>-------] ETA  2s  91%
#> 

#> Loading Tunisia [================================================================================>--------] ETA  2s  91%
#> 

#> Loading Türkiye [================================================================================>--------] ETA  2s  92%
#> 

#> Loading Turkmenistan [============================================================================>-------] ETA  2s  92%
#> 

#> Loading Uganda [==================================================================================>-------] ETA  1s  93%
#> 

#> Loading Ukraine [==================================================================================>------] ETA  1s  93%
#> 

#> Loading North Macedonia [===========================================================================>-----] ETA  1s  94%
#> 

#> Loading Egypt [=====================================================================================>-----] ETA  1s  94%
#> 

#> Loading United Kingdom [=============================================================================>----] ETA  1s  95%
#> 

#> Loading Channel Islands [============================================================================>----] ETA  1s  95%
#> 

#> Loading Tanzania [===================================================================================>----] ETA  1s  96%
#> 

#> Loading USA [========================================================================================>----] ETA  1s  96%
#> 

#> Loading U.S. Virgin Islands [=========================================================================>---] ETA  1s  97%
#> 

#> Loading Burkina Faso [================================================================================>---] ETA  1s  97%
#> 

#> Loading Uruguay [======================================================================================>--] ETA  0s  98%
#> 

#> Loading Uzbekistan [===================================================================================>--] ETA  0s  98%
#> 

#> Loading Venezuela [=====================================================================================>-] ETA  0s  99%
#> 

#> Loading Samoa [=========================================================================================>-] ETA  0s  99%
#> 

#> Loading Yemen [==========================================================================================>] ETA  0s 100%
#> 

#> Loading Zambia [==========================================================================================] ETA  0s 100%
#> 
#> [1] "Global starting parameters:"
#> [1] "Migration: TRUE"
#> [1] "Light migration: TRUE"
#> [1] "Switching: TRUE"
#> [1] "Light switching: TRUE"
#> [1] "Switching type: split"
#> [1] "Steps: 10"
#> [1] "No fertility differentials: FALSE"
#> [1] "Post switch separation: FALSE"
p_object <- variants_loader(projection_object = p_object)
#> [1] "Variant successfully loaded."