Skip to contents

Returns a dataframe of metadata for all groups that meet the filter applied.

Usage

list_groups(
  public = FALSE,
  shared = FALSE,
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  flat = FALSE,
  parent = NULL
)

Arguments

public

logical TRUE means list public arrays

shared

logical TRUE means list shared arrays. If public and shared are both false then arrays owned by you are listed.

page

integer

per.page

integer

character

namespace

character

orderby

character

permissions

character

tag

list( character )

exclude.tag

list( character )

flat

logical, if `TRUE`, ignores the nesting of groups and searches all of them

parent

character, search only the children of the groups with this uuid

Value

A `data.frame` of metadata for all groups in your account that meet the filter applied.

Details

Note that this is a paginable API but default params return all results on one call, even hundreds of them.

Pagination information is set as an attribute of the returned data frame.