HDXShowcase: HDX Showcase

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

Description

HDX Showcase

HDX Showcase

Details

HDX Showcase

Super class

rhdx::HDXObject -> HDXShowcase

Public fields

datasets

list of datasets using this showcase

data

the field info into list

Methods

Public methods

• HDXShowcase$new()

• HDXShowcase$get_datasets()

• HDXShowcase$browse()

• HDXShowcase$as_list()

• HDXShowcase$print()

• HDXShowcase$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 new Showcase object

Usage

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

Arguments

initial_data

list, data with required field to create Showcase

configuration

Configuration, configuration to use

Returns

a new Showcase object

---

Method get_datasets()

List datasets using the Showcase

Usage

HDXShowcase$get_datasets()

Returns

a list of dataset

---

Method browse()

Browse the Showcase page on HDX

Usage

HDXShowcase$browse()

---

Method as_list()

Get dataset field into list

Usage

HDXShowcase$as_list()

Returns

a list with showcase field info

---

Method print()

Print a Showcase object

Usage

HDXShowcase$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HDXShowcase$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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