download_wiki_image: Download image from Wikipedia

Description Usage Arguments Value Examples

View source: R/wiki_images.R

Description

Download image from Wikipedia

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
download_wiki_image(
  name,
  destfolder = ".",
  destfile = NULL,
  wiki = c("en", "de")[1],
  base_url = NULL,
  filter = NULL,
  which = c("first", "last", "random")[1],
  save_metadata = TRUE,
  verbose = FALSE,
  quiet_download = !verbose
)

Arguments

name

Name of Wikipedia entry.

destfolder, destfile

Destination folder and file name for saving image. If NULL (default), use name of Wikipedia page.

wiki

Which Wikipedia to use: English ("en", default), or German ("de").

base_url

Wikipedia base URL, which depends on wiki.

filter

Defaults to NULL, which will pick the appropriate filter. E.g., "/wiki/File:", depending on language.

which

Determines which picture to choose: Either "first" (default), "last", "random", or a numeric value indicating the picture number.

save_metadata

If TRUE (default and recommended), save extracted metadata (e.g., source URL, author, licence, if possible) to a .rds file with same file name as image file. The metadata is stored in a list format.

verbose

Logical; controls verbosity.

quiet_download

Passed to download.file() as its quiet argument. Defaults to !verbose.

Value

Invisible returns a list with metadata such as source URL, author, licence, if possible.

Examples

1
2
3
4
5
6
7
8
# res <- download_wiki_image("ArcGIS",
#                            destfile = "test", destfolder = "figures")
# res <- download_wiki_image("Stoppschild", wiki = "de",
#                            destfile = "test", destfolder = "figures")
# res <- download_wiki_image("Lake Winnipesaukee",
#                            destfile = "test", destfolder = "figures")
# res <- download_wiki_image("E10 (Kraftstoff)", wiki = "de", which = 2,
#                            destfolder = "figures")

alexanderbrenning/alexmisc documentation built on Jan. 7, 2022, 5:41 p.m.