Iteration

# Iteration
## <br><br> College of the Atlantic

---

# First Minister's COVID speeches

---

## 🏁 Start with

---

## End with 🛑

```
## # A tibble: 260 x 6
##    title                   date       locat~1 abstr~2 text  url  
##    <chr>                   <date>     <chr>   <chr>   <lis> <chr>
##  1 Coronavirus (COVID-19)~ 2022-02-22 Scotti~ Statem~ <chr> http~
##  2 Coronavirus (COVID-19)~ 2022-02-08 Scotti~ Statem~ <chr> http~
##  3 Coronavirus (COVID-19)~ 2022-02-01 Scotti~ Statem~ <chr> http~
##  4 Coronavirus (COVID-19)~ 2022-01-25 Scotti~ Statem~ <chr> http~
##  5 Coronavirus (COVID-19)~ 2022-01-18 Scotti~ Statem~ <chr> http~
##  6 Coronavirus (COVID-19)~ 2022-01-11 Scotti~ Statem~ <chr> http~
##  7 Coronavirus (COVID-19)~ 2022-01-05 Scotti~ Statem~ <chr> http~
##  8 Coronavirus (COVID-19)~ 2021-12-21 <NA>    Statem~ <chr> http~
##  9 Coronavirus (COVID-19)~ 2021-12-17 St And~ Statem~ <chr> http~
## 10 Coronavirus (COVID-19)~ 2021-12-14 Scotti~ Statem~ <chr> http~
## 11 Coronavirus (COVID-19)~ 2021-12-10 St And~ Statem~ <chr> http~
## 12 Coronavirus (COVID-19)~ 2021-12-07 Scotti~ Statem~ <chr> http~
## 13 Coronavirus (COVID-19)~ 2021-11-30 Scotti~ Statem~ <chr> http~
## 14 Coronavirus (COVID-19)~ 2021-11-29 St And~ Statem~ <chr> http~
## 15 Coronavirus (COVID-19)~ 2021-11-23 <NA>    Statem~ <chr> http~
## # ... with 245 more rows, and abbreviated variable names
## #   1: location, 2: abstract
```

---

## Define `scrape_speech()`

```r
scrape_speech <- function(url) {
  
  speech_page <- read_html(url)

title <- speech_page %>%
  html_element(".ds_page-header__title") %>%
  html_text()

date <- speech_page %>%
  html_element("#sg-meta__publication-date") %>%
  html_text() %>%
  dmy()

location <- speech_page %>%
  html_element(".ds_metadata__item:nth-child(5) strong") %>%
  html_text()

abstract <- speech_page %>%
  html_element(".ds_no-margin--bottom") %>%
  html_text()

text <- speech_page %>%
  html_elements("#preamble p") %>%
  html_text() %>%
  list()

tibble(
    title = title, date = date, location = location,
    abstract = abstract, text = text, url = url
  )
}
```
]
]

---

## Use `scrape_speech()`

```r
url_26_oct <- "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-speech-26-october/"
scrape_speech(url = url_26_oct)
```

```
## # A tibble: 1 x 6
##   title                    date       locat~1 abstr~2 text  url  
##   <chr>                    <date>     <chr>   <chr>   <lis> <chr>
## 1 Coronavirus (COVID-19) ~ 2020-10-26 St And~ Statem~ <chr> http~
## # ... with abbreviated variable names 1: location, 2: abstract
```

```r
url_23_oct <- "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-speech-23-october/"
scrape_speech(url = url_23_oct)
```

```
## # A tibble: 1 x 6
##   title                    date       locat~1 abstr~2 text  url  
##   <chr>                    <date>     <chr>   <chr>   <lis> <chr>
## 1 Coronavirus (COVID-19) ~ 2020-10-23 St And~ Statem~ <chr> http~
## # ... with abbreviated variable names 1: location, 2: abstract
```

---

# Inputs

---

## Inputs

.question[
You now have a function that will scrape the relevant info on speeches given the URL of the page of the speech. Where can we get a list of URLs of each of the speeches?
]

---

## All URLs

```r
all_speeches_page <- read_html("https://www.gov.scot/collections/first-ministers-speeches/")

all_speeches_page %>%
  html_elements(".collections-list a") %>%
  html_attr("href")
```

```
##   [1] "/publications/apology-historical-adoption-practices-first-ministers-speech-22-march-2023/"                   
##   [2] "/publications/scottish-womens-convention-first-ministers-speech-march-2023/"                                 
##   [3] "/publications/business-parliament-conference-first-ministers-speech-3-february-2023/"                        
##   [4] "/publications/first-ministers-speech-scottish-renewables-offshore-wind-conference-wednesday-25-january-2023/"
##   [5] "/publications/update-pressures-facing-nhs-first-ministers-speech-monday-16-january/"                         
##   [6] "/publications/pressures-facing-nhs-first-ministers-speech-monday-9-january/"                                 
##   [7] "/publications/thecityuk-annual-conference-first-ministers-speech-1-december-2022/"                           
##   [8] "/publications/poverty-alliance-30th-anniversary-conference-first-ministers-speech-25-november-2022/"         
##   [9] "/publications/cop27-loss-damage-panel-first-ministers-speech-8-november-2022/"                               
##  [10] "/publications/first-minister-opens-scottish-government-conference-loss-damage/"                              
...
```

---

## COVID-19 URLs *fragments*

```r
all_speeches_page %>%
  html_elements(".collections-list a") %>%
  html_attr("href") %>%
  str_subset("covid-19")
```

```
##   [1] "/publications/coronavirus-covid-19-update-first-ministers-speech-tuesday-22-february-2022/"     
##   [2] "/publications/coronavirus-covid-19-update-first-ministers-statement-8-february-2022/"           
##   [3] "/publications/coronavirus-covid-19-update-first-ministers-statement-1-february-2022/"           
##   [4] "/publications/coronavirus-covid-19-update-first-ministers-statement-25-january-2022/"           
##   [5] "/publications/coronavirus-covid-19-update-first-ministers-statement-18-january-2022/"           
##   [6] "/publications/coronavirus-covid-19-update-first-ministers-statement-11-january-2022/"           
##   [7] "/publications/coronavirus-covid-19-update-first-ministers-statement-5-january-2022/"            
##   [8] "/publications/coronavirus-covid-19-update-first-ministers-statement-21-december-2021/"          
##   [9] "/publications/coronavirus-covid-19-update-first-ministers-speech-17-december-2021/"             
##  [10] "/publications/coronavirus-covid-19-update-first-ministers-statement-14-december-2021/"          
...
```

---

## COVID-19 URLs

```r
all_speeches_page %>%
  html_elements(".collections-list a") %>%
  html_attr("href") %>%
  str_subset("covid-19") %>%
  str_c("https://www.gov.scot", .)
```

```
##   [1] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-speech-tuesday-22-february-2022/"     
##   [2] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-8-february-2022/"           
##   [3] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-1-february-2022/"           
##   [4] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-25-january-2022/"           
##   [5] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-18-january-2022/"           
##   [6] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-11-january-2022/"           
##   [7] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-5-january-2022/"            
##   [8] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-21-december-2021/"          
##   [9] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-speech-17-december-2021/"             
##  [10] "https://www.gov.scot/publications/coronavirus-covid-19-update-first-ministers-statement-14-december-2021/"          
...
```

---

## Save COVID-19 URLs

```r
covid_speech_urls <- all_speeches_page %>%
  html_elements(".collections-list a") %>%
  html_attr("href") %>%
  str_subset("covid-19") %>%
  str_c("https://www.gov.scot", .)

covid_speech_urls
```

---

# Iteration

---

## Define the task

- Goal: Scrape info on all COVID-19 speeches of the First Minister
- So far:

```r
scrape_speech(covid_speech_urls[1])
scrape_speech(covid_speech_urls[2])
scrape_speech(covid_speech_urls[3])
```
- What else do we need to do?
  - Run the `scrape_speech()` function on all COVID-19 speech links
  - Combine the resulting data frames from each run into one giant data frame

---

## Iteration

.question[
How can we tell R to apply the `scrape_speech()` function to each link in `covid_speech_urls`?
]

- Option 1: Write a **for loop**, i.e. explicitly tell R to visit a link, apply the function, store the result, then visit the next link, apply the function, append the result to the stored result from the previous link, and so on and so forth.
--

- Option 2: **Map** the function to each element in the list of links, and let R take care of the storing and appending of results.
--

- We'll go with Option 2!

---

## How does mapping work?

Suppose we have exam 1 and exam 2 scores of 4 students stored in a list...

```r
exam_scores <- list(
  exam1 <- c(80, 90, 70, 50),
  exam2 <- c(85, 83, 45, 60)
)
```

...and we find the mean score in each exam

```r
map(exam_scores, mean)
```

```
## [[1]]
## [1] 72.5
## 
## [[2]]
## [1] 68.25
```

---

...and suppose we want the results as a numeric (double) vector

```r
map_dbl(exam_scores, mean)
```

```
## [1] 72.50 68.25
```

...or as a character string

```r
map_chr(exam_scores, mean)
```

```
## [1] "72.500000" "68.250000"
```

---

## `map_something`

Functions for looping over an object and returning a value (of a specific type):

* `map()` - returns a list
* `map_lgl()` - returns a logical vector
* `map_int()` - returns a integer vector
* `map_dbl()` - returns a double vector
* `map_chr()` - returns a character vector
* `map_df()` / `map_dfr()` - returns a data frame by row binding
* `map_dfc()` - returns a data frame by column binding
* ...

---

## Go to each page, scrape speech

- Map the `scrape_speech()` function
- to each element of `covid_speech_urls`
- and return a data frame by row binding

```r
covid_speeches <- map_dfr(covid_speech_urls, scrape_speech)
```

---

```r
covid_speeches %>%
  print(n = 15)
```

---

## What could go wrong?

```r
covid_speeches <- map_dfr(covid_speech_urls, scrape_speech)
```

- This will take a while to run
- If you get `HTTP Error 429 (Too many requests)` you might want to slow down your hits by modifying your function to slow it down by adding a random wait (sleep) time between hitting each link

```r
scrape_speech <- function(url){
  
  # Sleep for randomly generated number of seconds
  # Generated from a uniform distribution between 0 and 1
* Sys.sleep(runif(1))
  
  # Rest of your function code goes here...
}
```

---
## Acknowledgements

* This course builds on the materials from [Data Science in a Box](https://datasciencebox.org/) developed by Mine Çetinkaya-Rundel and are adapted under the [Creative Commons Attribution Share Alike 4.0 International](https://github.com/rstudio-education/datascience-box/blob/master/LICENSE.md)