A Client for Data.world's REST API


[Up] [Top]

Documentation for package ‘dwapi’ version 0.1.1

Help Pages

dwapi-package dwapi: A client for data.world's REST API.
add_file Add a file to a request object.
add_file.dataset_create_request Add a file to a request object.
add_file.dataset_replace_request Add a file to a request object.
add_file.dataset_update_request Add a file to a request object.
add_file.default Add a file to a request object.
add_file.file_batch_update_request Add a file to a request object.
add_files_by_source Add one or more files to a dataset.
add_file_by_source Add a single file to a dataset.
auth_token Return the currently configured API authentication token
check_dataset_summary_response Validate 'get_dataset' response object.
check_file_summary_response Validate 'get_dataset' response files.
configure Library configuration tool.
create_dataset Create a new dataset.
create_dataset_response De-serialize a structured list into create_dataset_reponse object.
dataset_create_request Create request object for new datasets.
dataset_replace_request Create request object for replacing existing datasets.
dataset_summary_response Deserialize 'get_dataset' response object.
dataset_update_request Create request object for updating existing datasets.
delete_file Delete a single file from a dataset.
delete_files Delete one or more files from a dataset.
download_datapackage Download data package.
download_file Download file from dataset onto the local file system.
download_file_as_data_frame Download dataset file onto a data frame.
download_table_as_data_frame Download a dataset table onto a data frame.
dwapi dwapi: A client for data.world's REST API.
error_message Deserialize error response object.
extract_dataset_key Extract the dataset key from URL or as provided
file_batch_update_request Create request object for adding or updating dataset files.
file_create_or_update_request Create object for adding/updating a dataset file.
file_create_request Create object for adding a dataset file.
file_source_create_or_update_request Create object for adding/updating dataset file sources.
file_source_create_request Create object for adding dataset file sources.
file_source_summary_response Deserialize 'get_dataset' response file sources.
file_summary_response Deserialize 'get_dataset' response files.
get_dataset Retrieve dataset information.
get_table_schema Retrieve schema information for a dataset table.
list_tables List tables in a dataset.
parse_success_or_error Parse simple responses (success or error).
replace_dataset Replace an existing dataset.
sdk_version Return the current dwapi version
sparql Execute SPARQL query against a dataset.
sql Execute SQL query against a dataset.
success_message Deserialize success response object.
sync Fetch latest files from source and update dataset.
table_schema_field_response Deserialize 'get_table_schema' fields.
table_schema_field_update_request Create request object for updating table schema fields.
table_schema_response Deserialize 'get_table_schema' response object.
table_schema_update_request Create request object for updating table schema.
update_dataset Update an existing dataset.
update_table_schema Update table schema.
upload_data_frame Upload a data frame as a file to a dataset.
upload_file Upload a single file to a dataset.
upload_files Upload one or more files to a dataset.
user_agent Return the dwapi user-agent