A Client for 'data.world' REST API


[Up] [Top]

Documentation for package ‘dwapi’ version 0.1.3.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.
append_data_frame_to_stream Append an R data frame to a data.world stream.
append_record_to_stream Append a record, consisting of a list of depth one, to a stream.
append_values_to_stream Append a record, consisting of named parameters, to a stream.
auth_token Return the currently configured API authentication token
check_file_summary_response Validate 'get_dataset' response files.
check_project_summary_response Validate 'get_project' response object.
check_user_info_response Validate 'get_user' response object, returning the object if valid, and stopping with an error message if invalid.
configure Library configuration tool.
create_dataset Create a new dataset.
create_dataset_response De-serialize a structured list into create_dataset_reponse object.
create_insight Create an insight.
create_project Create a new project.
create_project_response De-serialize a structured list into create_project_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_dataset Delete a dataset
delete_file Delete a single file from a dataset.
delete_files Delete one or more files from a dataset.
delete_insight Delete an insight.
delete_project Delete a project.
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
extract_project_key Extract the project 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_datasets_user_contributing Search for datasets contributed-to by the currently authenticated user.
get_datasets_user_liked Search for datasets liked by the currently authenticated user.
get_datasets_user_own Search for datasets owned by the currently authenticated user.
get_insight Retrieve an insight.
get_insights Get insights for a project.
get_project Retrieve a project.
get_projects_user_contributing Search for projects contributed-to by the currently authenticated user.
get_projects_user_liked Search for projects liked by the currently authenticated user.
get_projects_user_own Search for projects owned by the currently authenticated user.
get_table_schema Retrieve schema information for a dataset table.
get_user Retrieve user information for the currently authenticated user.
insight_create_request Create insight object for new insights
insight_replace_request Create insight object for insights that replace existing insights
insight_summary_response Deserialize 'get_insight' response object.
insight_update_request Create insight object for updating existing insights
linked_dataset_create_or_update_request Create request object for new linked datasets, or updates to existing datasets.
link_dataset Link a dataset to a project.
list_tables List tables in a dataset.
parse_success_or_error Parse simple responses (success or error).
project_create_request Create request object for new projects.
project_replace_request Create request object for replacement of existing projects.
project_summary_response Deserialize 'get_project' response object.
project_update_request Create request object to update existing projects.
replace_dataset Replace an existing dataset.
replace_insight Replace an insight.
replace_project Create a new project with a specific ID, replacing a project with that ID if it exists.
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.
unlink_dataset Unlink a dataset from a project.
update_dataset Update an existing dataset.
update_insight Update an insight.
update_project Update an existing project.
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
user_info_response Deserialize 'get_user' response object.