HDX Dataset
HDX Dataset
Dataset class containing all logic for accessing, creating, and updating datasets and associated resources.
rhdx::HDXObject -> HDXDataset
resourceslist of Resource object within the dataset
dataplaceholder for Dataset field element
new()Create a new Dataset object
HDXDataset$new(initial_data = NULL, configuration = NULL)
initial_datalist with required field to create a dataset
configurationa Configuration object
A Dataset object
get_resource()Get a specific resource of the dataset
HDXDataset$get_resource(index)
index, the index of the resource to access
a Resource object, the selected resource
get_resources()Get all resources of the dataset
HDXDataset$get_resources(pattern = NULL, format = NULL)
patternregex pattern in resource name
formatformat of the resources
a list of Resource objects, all resources available in the dataset
number_of_resources()Get number of dataset resources
HDXDataset$number_of_resources()
The number of Resource objects
delete_resource()Delete a resource by its index
HDXDataset$delete_resource(index = 1L)
index, the index of the resource to delete
delete_resources()Delete all resources from a dataset
HDXDataset$delete_resources()
browse()Browse the dataset page on HDX
HDXDataset$browse()
get_configuration()Get the current configuration in use
HDXDataset$get_configuration()
A configuration object, the configuration in use
get_dataset_date()Get the dataset date
HDXDataset$get_dataset_date()
a date, the dataset date.
get_update_frequency()Get dataset update frequency
HDXDataset$get_update_frequency()
a character, the dataset update frequency Get dataset tags
get_tags()HDXDataset$get_tags()
a list of Tag objects, datasets tags
get_locations()Get the datasets location
HDXDataset$get_locations()
a list of Location objects, all locations covered by the dataset
get_maintainer()Get the dataset maintainer
HDXDataset$get_maintainer()
An User object, the maintainer of the dataset
get_organization()Get the dataset organization
HDXDataset$get_organization()
an Organization object, the organization that shared the data
get_showcases()Get the Showcase associated to the dataset
HDXDataset$get_showcases()
a Showcase object containing the dataset
is_requestable()Check if the dataset is requestable
HDXDataset$is_requestable()
a logical value, TRUE if it's a requestable dataset
get_required_fields()Get dataset required fields
HDXDataset$get_required_fields()
list of required fields for a dataset
check_required_fields()Check dataset required field
HDXDataset$check_required_fields()
a logical value, TRUE if the the dataset is not missing a required field and throws an error otherwise
as_list()Get dataset field into list
HDXDataset$as_list()
a list with dataset field
print()Print a Dataset object
HDXDataset$print()
clone()The objects of this class are cloneable with this method.
HDXDataset$clone(deep = FALSE)
deepWhether to make a deep clone.