HDXLocation: HDX Location

In dickoa/rhdx: A Client for the Humanitarian Data Exchange platform API

Description

HDX Location

HDX Location

Details

HDX location mostly countries

Super class

rhdx::HDXObject -> HDXLocation

Public fields

data

placeholder location

Methods

Public methods

• HDXLocation$new()

• HDXLocation$get_required_fields()

• HDXLocation$check_required_fields()

• HDXLocation$browse()

• HDXLocation$as_list()

• HDXLocation$print()

• HDXLocation$clone()

Inherited methods

• rhdx::HDXObject$check_required_field()

• rhdx::HDXObject$get_configuration()

• rhdx::HDXObject$update_from_json()

• rhdx::HDXObject$update_from_yaml()

---

Method new()

Create a new Location object

Usage

HDXLocation$new(initial_data = NULL, configuration = NULL)

Arguments

initial_data

list with required field to create a dataset

configuration

a Configuration object

Returns

A Location object

---

Method get_required_fields()

Get dataset required fields

Usage

HDXLocation$get_required_fields()

Returns

list of required fields for a dataset

---

Method check_required_fields()

Check dataset required field

Usage

HDXLocation$check_required_fields()

Returns

a logical value, TRUE if the the dataset is not missing a required field and throws an error otherwise

---

Method browse()

Browser the Location page on HDX

Usage

HDXLocation$browse()

---

Method as_list()

Get location field into list

Usage

HDXLocation$as_list()

Returns

a list with dataset field

---

Method print()

Print a Dataset object

Usage

HDXLocation$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HDXLocation$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

dickoa/rhdx documentation built on Oct. 13, 2021, 8:36 p.m.