pavo (version 2.5.0)

getimg: Import image data

Description

Finds and imports PNG, JPEG, and/or BMP images.

Usage

getimg(
  imgpath = getwd(),
  subdir = FALSE,
  subdir.names = FALSE,
  max.size = 1,
  cores
)

Arguments

imgpath

(required) either the full file-path or URL to an image (including extension), or the path to a folder in which multiple image files are located. Mixed file formats within a folder are accepted.

subdir

should subdirectories within the imgpath folder be included in the search? (defaults to FALSE).

subdir.names

should subdirectory path be included in the name of the images? (defaults to FALSE).

max.size

maximum size of all images to be allowed in memory, in GB. Defaults to 1.

cores

deprecated argument.

Value

a image, or list of images, of class rimg, for use in further pavo functions.

Examples

# NOT RUN {
# Single image
papilio <- getimg(system.file("testdata/images/papilio.png", package = "pavo"))

# Multiple images
snakes <- getimg(system.file("testdata/images/snakes", package = "pavo"))
# }