Vocabulary: HDX Vocabulary

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

Description

HDX Vocabulary

HDX Vocabulary

Details

HDX Vocabulary

Super class

rhdx::HDXObject -> Vocabulary

Public fields

data

list of tag field element

Methods

Public methods

• Vocabulary$new()

• Vocabulary$as_list()

• Vocabulary$authorized_tags_name()

• Vocabulary$print()

• Vocabulary$clone()

Inherited methods

• rhdx::HDXObject$browse()

• rhdx::HDXObject$check_required_field()

• rhdx::HDXObject$get_configuration()

• rhdx::HDXObject$get_required_fields()

• rhdx::HDXObject$update_from_json()

• rhdx::HDXObject$update_from_yaml()

---

Method new()

Create a new Tag object

Usage

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

Arguments

initial_data

list data with required fields to create a tag object

configuration

Configuration configuration to use

Returns

a Tag object

---

Method as_list()

Tag object to list

Usage

Vocabulary$as_list()

Returns

a list with of tag fields element

---

Method authorized_tags_name()

List of accepted tags on HDX

Usage

Vocabulary$authorized_tags_name()

Returns

a vector of tags name

---

Method print()

Print a Vocabulary object

Usage

Vocabulary$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Vocabulary$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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