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
images(id, download = FALSE, download_path, verbose = sbdi_config()$verbose)

images(id, download = FALSE, download_path, verbose = sbdi_config()$verbose)

Arguments

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 sbdi_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)

bioatlas/r-functionality documentation built on Nov. 1, 2020, 3:42 a.m.