Package 'mospiR'

Download all files for a dataset

Description

Download all files for a dataset

Usage

download_dataset(dataset_id, folder_path, api_key, overwrite = FALSE)

Arguments

dataset_id	Dataset 'idno'.
folder_path	Destination directory. The function makes the directory if it does not exist.
api_key	MoSPI API key.
overwrite	If 'FALSE' (default), the function does not download the files that are already in 'folder_path'.

Value

A character vector of the paths of the saved files, as an invisible value.

Examples

# This dataset is approximately 270 MB.
paths <- download_dataset(
  "DDI-IND-NSO-ASI-2020-21", tempdir(), Sys.getenv("MOSPI_KEY")
)

---

Download a single file from a dataset

Description

Download a single file from a dataset

Usage

download_file(dataset_id, file_name, folder_path, api_key, .files_cache = NULL)

Arguments

dataset_id	Dataset 'idno'.
file_name	File name from the 'name' column of [list_files()].
folder_path	Destination directory. The function makes the directory if it does not exist.
api_key	MoSPI API key.
.files_cache	A file list from [list_files()]. If 'NULL' (default), the function gets the file list from the portal. Use this argument when you download many files from one dataset. This prevents more API requests.

Value

The path of the saved file, as an invisible value. 'NULL' if the download is not successful.

Examples

path <- download_file(
  "DDI-IND-NSO-ASI-2020-21", "DDI-IND-NSO-ASI-2020-21.xml",
  tempdir(), Sys.getenv("MOSPI_KEY")
)

---

Extract a downloaded archive

Description

Extracts a '.zip', '.rar', '.7z' or '.tar' file from the portal. The function uses the archive package first. If the archive package is not installed or cannot extract the file, the function uses the command line tool 'unar'.

Usage

extract_archive(path, dir)

Arguments

path	Path of the archive file.
dir	Destination directory. The function makes the directory if it does not exist.

Details

On Linux, the archive package uses the libarchive of the system. libarchive versions before 3.7.4 (for example 3.7.2 in Ubuntu 24.04) give a "File CRC error" on some '.rar' files from the portal. To extract these files, install 'unar' ('sudo apt-get install unar' on Ubuntu, 'brew install unar' on macOS).

The function extracts into a temporary directory and then moves the files into 'dir'. Thus, if the extraction fails, 'dir' does not change, and the function does not make 'dir'. Files in 'dir' that have the same names as files in the archive are replaced.

Value

A character vector of the paths of the extracted files, as an invisible value. 'NULL' if the extraction is not successful.

Examples

src <- file.path(tempdir(), "example.txt")
writeLines("example", src)
zip_file <- file.path(tempdir(), "example.zip")
archive::archive_write_files(zip_file, src)
extract_archive(zip_file, file.path(tempdir(), "extracted"))

---

List datasets from the MoSPI Microdata Portal

Description

List datasets from the MoSPI Microdata Portal

Usage

list_datasets(api_key, page = NULL, query = NULL)

Arguments

api_key	MoSPI API key.
page	Page number to get. If 'NULL' (default), the function gets all the pages.
query	Text to find in the dataset titles. Upper case and lower case letters are equal. The comparison occurs on your computer.

Value

A data frame with the columns 'id', 'idno', 'title', and other columns. 'NULL' if the request is not successful.

Examples

page1 <- list_datasets(Sys.getenv("MOSPI_KEY"), page = 1)
head(page1[, c("idno", "title")])

---

List files available for a dataset

Description

List files available for a dataset

Usage

list_files(dataset_id, api_key)

Arguments

dataset_id	Dataset 'idno', for example '"DDI-IND-NSO-ASI-2020-21"'.
api_key	MoSPI API key.

Value

A data frame with the columns 'name', 'base64', 'size', and other columns. 'NULL' if the request is not successful.

Examples

files <- list_files("DDI-IND-NSO-ASI-2020-21", Sys.getenv("MOSPI_KEY"))

---