differences for PR #104

Author: actions-user

.DS_Store

@@ -89,7 +89,7 @@ Then we can obtain the contact matrix for the age categories we want by specifyi
 
 
 ``` r
-contact_data <- contact_matrix(
+contact_data <- socialmixr::contact_matrix(
   survey = polymod,
   countries = "United Kingdom",
   age.limits = c(0, 20, 40),
@@ -151,32 +151,75 @@ If `symmetric` is set to TRUE, the `contact_matrix()` function will internally u
 
 ::::::::::::::::::::::::::::::::::::::::::::::::
 
-The example above uses the POLYMOD survey. There are a number of surveys available in `socialmixr`, to list the available surveys use `list_surveys()`. To download a survey, we can use `get_survey()`
+The example above uses the POLYMOD survey. There are a number of surveys available in `socialmixr`. To list the available surveys, use `socialmixr::list_surveys()`. To download a survey, we can use `socialmixr::get_survey()`
 
 
 ``` r
-zambia_sa_survey <- get_survey("https://doi.org/10.5281/zenodo.3874675")
+# Access the contact survey data from Zenodo
+zambia_sa_survey <- socialmixr::get_survey(
+  "https://doi.org/10.5281/zenodo.3874675"
+)
+```
+
+:::::::::::::::::: spoiler
+
+You can explore all the available surveys from the Zenodo repository at <https://zenodo.org/communities/social_contact_data/>. If you are interested in accessing to a specific URL within R, you can try:
+
+```r
+library(socialmixr)
+library(tidyverse)
+
+# Get URL for Zambia contact survey data from {socialmixr}
+socialmixr::list_surveys() %>%
+  dplyr::filter(stringr::str_detect(title, "Zambia")) %>%
+  dplyr::pull(url)
 ```
 
+::::::::::::::::::
 
 
 ::::::::::::::::::::::::::::::::::::: challenge 
 
 ## Zambia contact matrix
 
-After downloading the survey, generate a symmetric contact matrix for Zambia using the following age bins:
+The R package {socialmixr} contains functions which can estimate contact matrices from POLYMOD and other surveys. Outputs include demographic information like population size and number of participants in the study. Using {socialmixr}: 
+
++ Get access to the survey from Zambia. 
++ Generate a symmetric contact matrix for Zambia using the following age bins:
+
+    + [0,20)
+    + 20+
+
++ Get access to the vector of `population` size per age bin from the `demography` dataset inside the contact matrix output.
+
+::::::::::::::::::::: hint
+
+The survey object `zambia_sa_survey` contains data from two countries. If you need to estimate the social contact matrix from data of the specific country of Zambia, identify what argument in `socialmixr::contact_matrix()` you need for this.
+
 
-+ [0,20)
-+ 20+
+``` r
+# Inspect the countries within the survey object
+levels(zambia_sa_survey$participants$country)
+```
+
+``` output
+[1] "South Africa" "Zambia"      
+```
+
+Similar to the code above, to access vector values within a dataframe, you can use the dollar-sign operator: `$`
+
+:::::::::::::::::::::
 
 ::::::::::::::::::::::::::::::::::::::::::::::::
 
 :::::::::::::::::::::::: instructor 
 
 
 ``` r
-contact_data_zambia <- contact_matrix(
+# Generate the contact matrix for Zambia only
+contact_data_zambia <- socialmixr::contact_matrix(
   survey = zambia_sa_survey,
+  countries = "Zambia", # key argument
   age.limits = c(0, 20),
   symmetric = TRUE
 )
@@ -191,27 +234,37 @@ Removing participants that have contacts without age information. To change this
 ```
 
 ``` r
+# Print the contact matrix for Zambia only
 contact_data_zambia
 ```
 
 ``` output
 $matrix
          contact.age.group
 age.group   [0,20)      20+
-   [0,20) 3.643137 2.282138
-   20+    1.795546 2.542346
+   [0,20) 3.650000 1.451168
+   20+    1.988136 2.461856
 
 $demography
    age.group population proportion  year
       <char>      <num>      <num> <int>
-1:    [0,20)   28813173  0.4403347  2010
-2:       20+   36621532  0.5596653  2010
+1:    [0,20)    8006201  0.5780636  2010
+2:       20+    5843835  0.4219364  2010
 
 $participants
    age.group participants proportion
       <char>        <int>      <num>
-1:    [0,20)          255 0.07535461
-2:       20+         3129 0.92464539
+1:    [0,20)          180 0.08490566
+2:       20+         1940 0.91509434
+```
+
+``` r
+# Print the vector of population size for {epidemics}
+contact_data_zambia$demography$population
+```
+
+``` output
+[1] 8006201 5843835
 ```
 :::::::::::::::::::::::::::::::::
 
@@ -315,7 +368,7 @@ Normalisation can be performed by the function `contact_matrix()` in `{socialmix
 
 
 ``` r
-contact_data_split <- contact_matrix(
+contact_data_split <- socialmixr::contact_matrix(
   survey = polymod,
   countries = "United Kingdom",
   age.limits = c(0, 20, 40),

contact-matrices.md

@@ -4,7 +4,7 @@
 "config.yaml" "a0c04c1d43ce0640c3ea333b140e89c8" "site/built/config.yaml" "2025-07-15"
 "index.md" "32bc80d6f4816435cc0e01540cb2a513" "site/built/index.md" "2025-07-15"
 "links.md" "8184cf4149eafbf03ce8da8ff0778c14" "site/built/links.md" "2025-07-15"
-"episodes/contact-matrices.Rmd" "58cf0b0b77bddf65087de009f15466e0" "site/built/contact-matrices.md" "2025-07-23"
+"episodes/contact-matrices.Rmd" "19856620d33f9b7f4e8ee312460494f1" "site/built/contact-matrices.md" "2025-07-23"
 "episodes/simulating-transmission.Rmd" "f9c2d01ff04250732a0c24b06cfac63f" "site/built/simulating-transmission.md" "2025-07-23"
 "episodes/model-choices.Rmd" "aa195e66455fb6a97b4930fd08c08001" "site/built/model-choices.md" "2025-07-15"
 "episodes/modelling-interventions.Rmd" "0f695729b90387ec3449f9c46c9b4ae7" "site/built/modelling-interventions.md" "2025-07-15"