RIDLContainer: RIDL Container

In dickoa/ridl: A Client for the UNHCR RIDL Platform API

RIDL Container

Description

RIDL Container

RIDL Container

Details

RIDLContainer, it contains all the logic for creating, checking, and updating resources

Super class

ridl::RIDLObject -> RIDLContainer

Public fields

data

placeholder for the Container fields element

Methods

Public methods

• RIDLContainer$new()

• RIDLContainer$ridl_browse()

• RIDLContainer$get_fields()

• RIDLContainer$get_required_fields()

• RIDLContainer$check_required_fields()

• RIDLContainer$as_list()

• RIDLContainer$print()

• RIDLContainer$clone()

Inherited methods

• ridl::RIDLObject$browse_on_ridl()
• ridl::RIDLObject$get_config()

---

Method new()

Create a Container object

Usage

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

Arguments

initial_data

list with required field to create a dataset

configuration

a Configuration object

Returns

A Container object

---

Method ridl_browse()

Browse the Container page on RIDL

Usage

RIDLContainer$ridl_browse()

---

Method get_fields()

Get container fields

Usage

RIDLContainer$get_fields()

Returns

list of fields for a dataset

---

Method get_required_fields()

Get container required fields

Usage

RIDLContainer$get_required_fields()

Returns

list of required fields for a container

---

Method check_required_fields()

Check container required field

Usage

RIDLContainer$check_required_fields()

Returns

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

---

Method as_list()

Get dataset field into list

Usage

RIDLContainer$as_list()

Returns

a list with container field element

---

Method print()

Print a Dataset object

Usage

RIDLContainer$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RIDLContainer$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

dickoa/ridl documentation built on April 23, 2023, 7:14 p.m.