HDXOrganization: HDX Organization

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

Description

HDX Organization

HDX Organization

Details

HDX Organization

Super class

rhdx::HDXObject -> HDXOrganization

Public fields

data

placeholder for the Organization fields element

Methods

Public methods

• HDXOrganization$new()

• HDXOrganization$get_datasets()

• HDXOrganization$browse()

• HDXOrganization$as_list()

• HDXOrganization$print()

• HDXOrganization$clone()

Inherited methods

• 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 Organization object

Usage

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

Arguments

initial_data

list with required field to create a dataset

configuration

a Configuration object

Returns

A Organization object

---

Method get_datasets()

Get the list of datasets within the organization

Usage

HDXOrganization$get_datasets()

Returns

list of Dataset objects

---

Method browse()

Browse the Organization page on HDX

Usage

HDXOrganization$browse()

---

Method as_list()

Get dataset field into list

Usage

HDXOrganization$as_list()

Returns

a list with organization field element

---

Method print()

Print a Dataset object

Usage

HDXOrganization$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HDXOrganization$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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