HDXUser: HDX User

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

Description

HDX User

HDX User

Details

HDX user

Super class

rhdx::HDXObject -> HDXUser

Public fields

data

placeholder for Dataset field element

Methods

Public methods

• HDXUser$new()

• HDXUser$as_list()

• HDXUser$browse()

• HDXUser$print()

• HDXUser$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

Usage

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

Arguments

initial_data

list of field required to create a dataset

configuration

Configuration configuration to use

Returns

a new User object

---

Method as_list()

Get dataset field into list

Usage

HDXUser$as_list()

Returns

a list with dataset field

---

Method browse()

Browse the user page on HDX

Usage

HDXUser$browse()

---

Method print()

Print a User object

Usage

HDXUser$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HDXUser$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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