HDXObject: HDXObject abstract class

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

Description

HDXObject abstract class

HDXObject abstract class

Details

HDXObject class containing all logic for accessing, creating, and updating HDX objects.

Public fields

data

placeholder for HDXObject field element

Methods

Public methods

• HDXObject$new()

• HDXObject$update_from_yaml()

• HDXObject$update_from_json()

• HDXObject$get_required_fields()

• HDXObject$check_required_field()

• HDXObject$as_list()

• HDXObject$browse()

• HDXObject$get_configuration()

• HDXObject$print()

• HDXObject$clone()

---

Method new()

Create a new HDXObject object

Usage

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

Arguments

initial_data

list with required field to create a HDXObject

configuration

a Configuration object

Returns

A HDXObject object

---

Method update_from_yaml()

Update metadata from yaml file

Usage

HDXObject$update_from_yaml(path)

Arguments

path

(character) Path to YAML metadata

---

Method update_from_json()

Update metadata from json file

Usage

HDXObject$update_from_json(path)

Arguments

path

(character) Path to JSON metadata

---

Method get_required_fields()

Get HDXObject required fields

Usage

HDXObject$get_required_fields()

Returns

list of required fields for a resource

---

Method check_required_field()

Check HDXobject required field

Usage

HDXObject$check_required_field()

Returns

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

---

Method as_list()

Get HDXObject field into list

Usage

HDXObject$as_list()

Returns

a list with HDXObject field

---

Method browse()

Browse HDX

Usage

HDXObject$browse()

---

Method get_configuration()

Get the current configuration in use

Usage

HDXObject$get_configuration()

Returns

A configuration object, the configuration in use

---

Method print()

Print a Dataset object

Usage

HDXObject$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HDXObject$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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