images: Retrieve image information using image ids, with an option to...

Description Usage Arguments Value References Examples

View source: R/images.R

Description

Retrieve image information using image ids, with an option to download

Usage

1
2
3
4
5
6
images(
  image_id,
  download = FALSE,
  download_path,
  verbose = ala_config()$verbose
)

Arguments

image_id

character: IDs of images to be downloaded as single string or vector of strings

download

logical: if TRUE download all images and add location to dataframe

download_path

string: (optional) filepath to download images to. If not given and download param is TRUE, will create an images folder

verbose

logical: show additional progress information? [default is set by ala_config()]

Value

Data frame of image results

References

Examples

1
2
3
4
5
## Not run: 
## Retrieve infomation about an image and download
images(id="da5fe120-e213-4cd6-9c5f-62346ed2e466", download=TRUE)

## End(Not run)

AtlasOfLivingAustralia/ALA4R documentation built on Sept. 16, 2021, 4:33 a.m.