R/history_france_ex.R

In cimentadaj/scrapex: Data package containing websites saved locally for web scraping examples

##' This example hosts data from the website https://en.wikipedia.org/wiki/History_of_France
##' which documents the entire history of France.
##'
##' This function returns the full HTML links to the local HTML files that can be used as exercises for scraping the data as if this was the online hosted version.
##'
##' Please note that this website are not meant
##' to be used to reliably explore their hyperlinks or other features, as
##' these will change inevitably when the website changes some of it's
##' structures. This is because some of the links still point to the
##' real website or other platforms.
##'
##' @title Return the paths to the complete HTML website of history of France.
##' @return A character vector with with 1 local HTML link
##' @author Jorge Cimentada
##' @export
##'
##' @examples
##'
##' library(xml2)
##' library(scrapex)
##'
##' one_link <- history_france_ex()
##'
##' read_html(one_link)
##'
##' \dontrun{
##' # If you want to look at the website in your browser
##' # just wrap it in prep_browser and pass it to browseURL
##' browseURL(prep_browser(one_link))
##' }
##'
history_france_ex <- function() {
  pkg_dir <- system.file(package = "scrapex")
  dir_data <- file.path(pkg_dir, "extdata", "history_france/")

  html_files <-
    list.files(dir_data,
               pattern = "History_.+\\.html$",
               recursive = TRUE,
               full.names = TRUE)

  html_files
}