diff --git a/documentation/figures/GUI/Chart Properties.png b/documentation/wiki/figures/GUI/Chart Properties.png similarity index 100% rename from documentation/figures/GUI/Chart Properties.png rename to documentation/wiki/figures/GUI/Chart Properties.png diff --git a/documentation/figures/GUI/Charts.png b/documentation/wiki/figures/GUI/Charts.png similarity index 100% rename from documentation/figures/GUI/Charts.png rename to documentation/wiki/figures/GUI/Charts.png diff --git a/documentation/figures/GUI/Output stream.png b/documentation/wiki/figures/GUI/Output stream.png similarity index 100% rename from documentation/figures/GUI/Output stream.png rename to documentation/wiki/figures/GUI/Output stream.png diff --git a/documentation/figures/GUI/SimPaths GUI.png b/documentation/wiki/figures/GUI/SimPaths GUI.png similarity index 100% rename from documentation/figures/GUI/SimPaths GUI.png rename to documentation/wiki/figures/GUI/SimPaths GUI.png diff --git a/documentation/figures/GUI/SimPaths parameters.png b/documentation/wiki/figures/GUI/SimPaths parameters.png similarity index 100% rename from documentation/figures/GUI/SimPaths parameters.png rename to documentation/wiki/figures/GUI/SimPaths parameters.png diff --git a/documentation/figures/GUI/SimPaths-Buttons.png b/documentation/wiki/figures/GUI/SimPaths-Buttons.png similarity index 100% rename from documentation/figures/GUI/SimPaths-Buttons.png rename to documentation/wiki/figures/GUI/SimPaths-Buttons.png diff --git a/documentation/figures/GUI/SimPaths-Chart-Zoom.png b/documentation/wiki/figures/GUI/SimPaths-Chart-Zoom.png similarity index 100% rename from documentation/figures/GUI/SimPaths-Chart-Zoom.png rename to documentation/wiki/figures/GUI/SimPaths-Chart-Zoom.png diff --git a/documentation/figures/modules/disability_module.png b/documentation/wiki/figures/modules/disability_module.png similarity index 100% rename from documentation/figures/modules/disability_module.png rename to documentation/wiki/figures/modules/disability_module.png diff --git a/documentation/figures/modules/education_module.png b/documentation/wiki/figures/modules/education_module.png similarity index 100% rename from documentation/figures/modules/education_module.png rename to documentation/wiki/figures/modules/education_module.png diff --git a/documentation/figures/modules/family_composition_module.png b/documentation/wiki/figures/modules/family_composition_module.png similarity index 100% rename from documentation/figures/modules/family_composition_module.png rename to documentation/wiki/figures/modules/family_composition_module.png diff --git a/documentation/figures/modules/fertility_module.png b/documentation/wiki/figures/modules/fertility_module.png similarity index 100% rename from documentation/figures/modules/fertility_module.png rename to documentation/wiki/figures/modules/fertility_module.png diff --git a/documentation/figures/modules/health_module.png b/documentation/wiki/figures/modules/health_module.png similarity index 100% rename from documentation/figures/modules/health_module.png rename to documentation/wiki/figures/modules/health_module.png diff --git a/documentation/figures/modules/mental_health_cases_module.png b/documentation/wiki/figures/modules/mental_health_cases_module.png similarity index 100% rename from documentation/figures/modules/mental_health_cases_module.png rename to documentation/wiki/figures/modules/mental_health_cases_module.png diff --git a/documentation/figures/modules/mental_health_levels_module.png b/documentation/wiki/figures/modules/mental_health_levels_module.png similarity index 100% rename from documentation/figures/modules/mental_health_levels_module.png rename to documentation/wiki/figures/modules/mental_health_levels_module.png diff --git a/documentation/figures/modules/partnership_module.png b/documentation/wiki/figures/modules/partnership_module.png similarity index 100% rename from documentation/figures/modules/partnership_module.png rename to documentation/wiki/figures/modules/partnership_module.png diff --git a/documentation/figures/modules/union_matching_module.png b/documentation/wiki/figures/modules/union_matching_module.png similarity index 100% rename from documentation/figures/modules/union_matching_module.png rename to documentation/wiki/figures/modules/union_matching_module.png diff --git a/documentation/wiki/overview/simulated-modules.md b/documentation/wiki/overview/simulated-modules.md index b16eaa480..886cefa87 100644 --- a/documentation/wiki/overview/simulated-modules.md +++ b/documentation/wiki/overview/simulated-modules.md @@ -22,7 +22,7 @@ The education module determines transitions into and out of student status. Stud
-Education +Education _Student status_ @@ -48,7 +48,7 @@ The health module projects an individual’s health status, comprising both self Physical health status is projected on a discrete 5-point scale, designed to reflect self-reported survey responses (between “poor” and “excellent” health). Physical health dynamics are based on an ordered probit, distinguishing those still in continuous education. For continuing full-time students, the ordered probit conditions on gender, age, lagged benefit unit income quintile, lagged physical health status, region, and year. The same variables are considered for individuals who have left continuous education, with the addition of education level, lagged employment status, and lagged benefit unit composition. -Health (self-rated) +Health (self-rated) @@ -58,7 +58,7 @@ Physical health status is projected on a discrete 5-point scale, designed to ref Any individual aged 16 and above who is not in continuous education can become long-term sick or disabled. The probability of being long-term sick or disabled is described by a probit equation defined with respect to lagged disability status, prevailing and lagged physical health status, gender, age, education, income quintile, and lagged family demographics. -Disability +Disability This Disability module is integrated in the `Person.health()` (Physical health) method in the current SimPaths model. We split disability out for illustration purpose. @@ -72,14 +72,14 @@ We split disability out for illustration purpose. * Psychological distress 1 (baseline level and caseness) In each simulation cycle, a baseline level of psychological distress for individuals aged 16 and over is determined using the 12-item General Health Questionnaire (GHQ-12). Two indicators of psychological distress are computed: a Likert score, between 0 and 36, estimated using a linear regression model; and a dichotomous indicator of the presence of potentially clinically significant common mental disorders is obtained using a logistic regression model. Both specifications are conditional on the lagged number of dependent children, lagged health status, lagged mental health, gender, age, level of education, household composition, region, and year. -Mental health (levels)\ +Mental health (levels)\ **Figure, psychological distress in levels** * Psychological distress 2 (impact of economic transitions and exposure to the Covid-19 pandemic) The baseline measures of the level and caseness of psychological distress described above are modified by the effects of economic transitions and non-economic exposure to the Covid-19 pandemic. Fixed effects regressions are used to estimate the direct impact of transitions from employment to non-employment, non-employment to employment, non-employment to long-term non-employment, non-poverty to poverty, poverty to non-poverty, and poverty to long-term poverty, as well as changes in growth rate of household income, a decrease in household income, and non-economic effect of the exposure to Covid-19 pandemic in years 2020 and 2021. The effects of economic transitions are estimated on pre-pandemic data to ensure validity in other periods. The non-economic effects of the pandemic are estimated using a multilevel mixed-effects generalized linear model. -Mental health (cases)\ +Mental health (cases)\ **Figure, psychological distress in cases** @@ -97,7 +97,7 @@ Females in couples can give birth to a (single) child in each simulated year, as
4.1 Family composition module code structure
-Family composition module overview +Family composition module overview This figure illustrates the timeline of the family composition module as defined by the `buildSchedule()` method in the SimPathsModel class. Every year the model conducts union matching to form households and benefit unions. Specifically, the model executes: @@ -144,7 +144,7 @@ Individuals who enter a partnership are matched using either a parametric or non The cohabitation method (in Person class) computes a group of persons to be considered in the union matching process (a map of personsToMatch). -Partnership method +Partnership method @@ -157,7 +157,7 @@ The cohabitation method (in Person class) computes a group of persons to be cons The `UnionMatching` class receives sets of unmatched males and females (passed as unmatched, constructed from personsToMatch) and forms new couples by creating benefit units and households via male.setupNewBenefitUnit(female, true). -UnionMatching +UnionMatching The key method, `evaluateGM()`, implements the global matching procedure as follows: @@ -212,7 +212,7 @@ Females aged 18 to 44 can give birth to a child whenever they are identified in
-fertility module +fertility module _Alignment_ The number of projected births is aligned to the number of newborns supplied by the official projections used for population alignment. The alignment procedure randomly samples fertile women and adjusts the outcome of the fertility process until the target number of newborns has been met. @@ -390,12 +390,12 @@ Although net wealth is not disaggregated in the model, the incidence of homeowne A secondary subjective-wellbeing process adjusts estimates obtained by the primary process to account for the effect of exposure to labour market transitions, such as moving in and out of employment and/or poverty. Specifically, in the SimPaths model, method `Person.healthMentalHM2level()` corresponds to the Step 2 of such a mental health evaluation, as illustrated in the right half of the Figure 1 below: -Mental health (levels)\ +Mental health (levels)\ **Figure 1, psychological distress in levels** The first and second processes for mental health in cases are combined, as illustrated in Figure 2, where processes `HM2CasesFemales` and `HM2CasesMales` correspond to the second process. -Mental health (cases)\ +Mental health (cases)\ **Figure 2, psychological distress in cases**