jpinfect (version 2023.2026.02)

jpinfect_get_bullet: Download the bullet reports from the Japan Institute for Health Security (JIHS)

Description

This function downloads surveillance data from the Japan Institute for Health Security (JIHS) for a specified year and weeks, based on the chosen language (English or Japanese).

Usage

jpinfect_get_bullet(
  year = NULL,
  week = 1:53,
  language = "en",
  overwrite = FALSE,
  dest_dir = NULL
)

Value

No return value. The function downloads surveillance data files from JIHS and saves them to the specified directory (`dest_dir`). If the data is unavailable for certain weeks, those weeks are skipped, and an appropriate message is displayed.

Arguments

year

An integer specifying the year of the data. Must be provided explicitly and must be greater than 2023.

week

A numeric vector specifying the weeks to download (default is 1:53). Week numbers should be between 1 and 53.

language

A character string specifying the language of the data ('en' for English, 'jp' for Japanese). Default is 'en'.

overwrite

A logical value indicating whether to overwrite existing files (default is FALSE). If FALSE, existing files are skipped, and only new files are downloaded.

dest_dir

Directory to save files. If NULL, uses tempdir() (files deleted when R session ends). Specify a permanent directory to keep downloaded data.

Details

- The function constructs a URL for JIHS data based on the year, week, and language using `jpinfect_url_bullet`. - If the specified week is invalid (not between 1 and 53), an error is raised. - If the year is earlier than 2024, an error is raised, as the function only works for years after 2023. - Weeks without available data on the server are skipped, and a warning is displayed for each unavailable week. - If the requested file already exists and `overwrite = FALSE`, it is skipped. - A delay (`Sys.sleep(3)`) is used between downloads to avoid overwhelming the server. - Progress updates are displayed in the console using `message()`.

Examples

# \donttest{
# Download English data for weeks 1 to 2 in 2025
jpinfect_get_bullet(year = 2025, week = 1:2, language = "en")

# Download Japanese data for weeks 1 to 2 in 2025
jpinfect_get_bullet(year = 2025, week = 1:2, language = "jp")

# Overwrite existing files and download English data for week 2 in 2025
jpinfect_get_bullet(year = 2025, week = 2, language = "en",
                     overwrite = TRUE)
# }