list_locations: List locations

Description Usage Arguments Value Examples

Description

List locations

Usage

1
2
3
4
5
6
list_locations(
  sort = "name asc",
  all_fields = FALSE,
  configuration = NULL,
  ...
)

Arguments

sort

Character sorting of the search results. Default: “name asc”, the allowed fields are ‘name’, ‘package_count’ and ‘title’

all_fields

Logical if TRUE returns list instead of just names

configuration

a Configuration

...

Extra parameters to group_list https://docs.ckan.org/en/ckan-2.8.2/api/index.html#ckan.logic.action.get.group_list

Value

A vector of locations names

Examples

1
2
3
4
5
6
## Not run: 
# Setting the config to use HDX default server
 set_rhdx_config()
 list_locations(limit = 10L)

## End(Not run)

dickoa/rhdx documentation built on May 7, 2020, 2 p.m.