images: Get list of images and their metadata, or a single image

Description Usage Arguments Examples

View source: R/images.R

Description

Get list of images and their metadata, or a single image

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
as.image(x)

images(
  private = FALSE,
  type = NULL,
  page = 1,
  per_page = 25,
  public = TRUE,
  ...
)

image(id, ...)

Arguments

x

Object to coerce to an image.

private

Include public images? If FALSE, returns only the images that you've created (with snapshots).

type

(character) One of distribution or application. Default: NULL (no type parameter passed)

page

Page to return. Default: 1.

per_page

Number of results per page. Default: 25.

public

Include public images? If FALSE, returns only the images that you've created (with snapshots).

...

Additional arguments passed down to low-level API function (do_*)

id

(numeric) Image id.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Not run: 
images()

# list private images
images(private = TRUE)

# list by type
images(type = "distribution")
images(type = "application")

# paging
images(per_page = 3)
images(per_page = 3, page = 2)

## End(Not run)

analogsea documentation built on Nov. 9, 2021, 1:06 a.m.