Function reference

All functions

RIDLConfig

RIDL Configuration

RIDLContainer

RIDL Container

RIDLDataset

RIDL Dataset

RIDLObject

RIDLObject abstract class

RIDLResource

RIDL Resource

rc_metadata_country rc_metadata_sectoral_area rc_metadata_uat_country rc_metadata_uat_sectoral_area

Container country metadata schema on the production server

rd_metadata_archived rd_metadata_data_collection_technique rd_metadata_data_sensitivity rd_metadata_external_access_level rd_metadata_identifiability rd_metadata_keywords rd_metadata_operational_purpose_of_data rd_metadata_process_status rd_metadata_sampling_procedure rd_metadata_visibility rd_metadata_uat_archived rd_metadata_uat_data_collection_technique rd_metadata_uat_data_sensitivity rd_metadata_uat_external_access_level rd_metadata_uat_identifiability rd_metadata_uat_keywords rd_metadata_uat_operational_purpose_of_data rd_metadata_uat_process_status rd_metadata_uat_sampling_procedure rd_metadata_uat_visibility

Dataset archived metadata schema on the production server

ridl ridl-package

ridl

ridl_browse()

Browse a RIDL object

ridl_cache_set_dir() ridl_cache_get_dir() ridl_cache_list() ridl_cache_delete() ridl_cache_clear()

Caching RIDL downloaded files

ridl_clone()

Copy metadata from a RIDL object

ridl_config() ridl_config_set() ridl_config_setup() ridl_config_get()

Create a RIDL configuration object

ridl_config_delete()

Delete the ridl config

ridl_container()

Create a RIDL container from list

ridl_container_country()

A dictionnary with the labels and values for container country

ridl_container_create() rc_create()

Create a container on RIDL

ridl_container_exist() rc_exist()

Check if a container name or id is available on RIDL

ridl_container_hierarchy_list() rc_hierarchy_list()

List container containers hierarchy

ridl_container_list() rc_list()

List RIDL containers

ridl_container_patch() rc_patch()

Patch a container on RIDL

ridl_container_sector()

A dictionnary with the labels and values for container sectoral areas

ridl_container_show() rc_show()

Pull a RIDL container

ridl_container_update() rc_update()

Update a container on RIDL

ridl_dataset()

Create a RIDL dataset from list

ridl_dataset_container_get() rd_container_get()

Get the dataset container

ridl_dataset_container_set() rd_container_set()

Add a dataset to a container

ridl_dataset_create() rd_create()

Create a dataset on RIDL

ridl_dataset_delete() rd_delete() ridl_dataset_delete() rd_delete()

Delete a dataset

ridl_dataset_exist() rd_exist()

Check if a dataset name or id is available on RIDL

ridl_dataset_list() rd_list()

List RIDL datasets

ridl_dataset_patch() rd_patch()

Patch a dataset on RIDL

ridl_dataset_resource_add() rd_resource_add()

Add a Resource to a dataset

ridl_dataset_resource_count() rd_resource_count()

Get the number of resources in the dataset

ridl_dataset_resource_delete() rd_resource_delete()

Delete resource from a dataset

ridl_dataset_resource_delete_all() rd_resource_delete_all()

Delete all resources from dataset

ridl_dataset_resource_get() rd_resource_get()

Access the nth resource of a dataset

ridl_dataset_resource_get_all() rd_resource_get_all()

List all the resources in a dataset

ridl_dataset_search() rd_search()

Search for datasets on RIDL

ridl_dataset_show() rd_show()

Pull and show a RIDL dataset

ridl_dataset_update() rd_update()

Update a dataset on RIDL

ridl_memoise_clear()

Clear memory cache used to memoise ridl functions

ridl_resource()

Create a RIDL resource from list

ridl_resource_create() rr_create()

Create a resource on RIDL

ridl_resource_dataset.RIDLResource() rr_dataset()

Get the dataset containing the resource

ridl_resource_download() rr_download()

Download a RIDL resource

ridl_resource_excel_sheets() rr_excel_sheets()

Get the names of the sheets of XLS(X) resources

ridl_resource_exist() rr_exist()

Check if a resource id is available on RIDL

ridl_resource_file_format() rr_file_format()

Get the file format of the resource

ridl_resource_file_to_upload() rr_file_to_upload() `ridl_resource_file_to_upload<-`() `rr_file_to_upload<-`()

Get and set the file to upload

ridl_resource_patch() rr_patch()

Patch a resource on RIDL

ridl_resource_read() rr_read()

Read a RIDL Resource

ridl_resource_search() rr_search()

Search for RIDL resources

ridl_resource_show() rr_show()

Pull a RIDL resource

ridl_resource_update() rr_update()

Update a resource on RIDL

rr_metadata_file_type rr_metadata_hxlated rr_metadata_identifiability rr_metadata_process_status rr_metadata_type rr_metadata_visibility rr_metadata_uat_confidentiality_status rr_metadata_uat_file_type rr_metadata_uat_hxlated rr_metadata_uat_identifiability rr_metadata_uat_process_status rr_metadata_uat_type rr_metadata_uat_visibility

Resource file type metadata schema on the production server