Man pages for dwapi
A Client for '' REST API

add_fileAdd a file to a request object.
add_file_by_sourceAdd a single file to a dataset.
add_files_by_sourceAdd one or more files to a dataset.
append_data_frame_to_streamAppend an R data frame to a stream.
append_record_to_streamAppend a record, consisting of a list of depth one, to a...
append_values_to_streamAppend a record, consisting of named parameters, to a stream.
auth_tokenReturn the currently configured API authentication token
check_file_summary_responseValidate 'get_dataset' response files.
check_project_summary_responseValidate 'get_project' response object.
check_user_info_responseValidate 'get_user' response object, returning the object if...
configureLibrary configuration tool.
create_datasetCreate a new dataset.
create_dataset_responseDe-serialize a structured list into create_dataset_reponse...
create_insightCreate an insight.
create_insight_responseDe-serialize a structured list into create_insight_response...
create_projectCreate a new project.
create_project_responseDe-serialize a structured list into create_project_reponse...
dataset_create_requestCreate request object for new datasets.
dataset_replace_requestCreate request object for replacing existing datasets.
dataset_summary_responseDeserialize 'get_dataset' response object.
dataset_update_requestCreate request object for updating existing datasets.
delete_datasetDelete a dataset
delete_fileDelete a single file from a dataset.
delete_filesDelete one or more files from a dataset.
delete_insightDelete an insight.
delete_projectDelete a project.
download_datapackageDownload data package.
download_fileDownload file from dataset onto the local file system.
download_file_as_data_frameDownload dataset file onto a data frame.
download_table_as_data_frameDownload a dataset table onto a data frame.
dwapidwapi: A client for's REST API.
error_messageDeserialize error response object.
extract_dataset_keyExtract the dataset key from URL or as provided
extract_project_keyExtract the project key from URL or as provided
file_batch_update_requestCreate request object for adding or updating dataset files.
file_create_or_update_requestCreate object for adding/updating a dataset file.
file_create_requestCreate object for adding a dataset file.
file_source_create_or_update_requestCreate object for adding/updating dataset file sources.
file_source_create_requestCreate object for adding dataset file sources.
file_source_summary_responseDeserialize 'get_dataset' response file sources.
file_summary_responseDeserialize 'get_dataset' response files.
get_datasetRetrieve dataset information.
get_datasets_user_contributingSearch for datasets contributed-to by the currently...
get_datasets_user_likedSearch for datasets liked by the currently authenticated...
get_datasets_user_ownSearch for datasets owned by the currently authenticated...
get_insightRetrieve an insight.
get_insight_optional_fieldsGet the insight optional fields
get_insight_required_fieldsGet the insight required fields
get_insightsGet insights for a project.
get_projectRetrieve a project.
get_project_required_fieldsGet the project required fields
get_projects_user_contributingSearch for projects contributed-to by the currently...
get_projects_user_likedSearch for projects liked by the currently authenticated...
get_projects_user_ownSearch for projects owned by the currently authenticated...
get_table_schemaRetrieve schema information for a dataset table.
get_userRetrieve user information for the currently authenticated...
get_user_library_itemSearch for library items owned by, liked by, or...
handle_library_errStop execution with a message when the response contains an...
insight_create_requestCreate insight object for new insights
insight_replace_requestCreate insight object for insights that replace existing...
insight_summary_responseDeserialize 'get_insight' response object.
insight_update_requestCreate insight object for updating existing insights
is.blankDetermine if a value has NA or zero-length character...
link_datasetLink a dataset to a project.
linked_dataset_create_or_update_requestCreate request object for new linked datasets, or updates to...
list_tablesList tables in a dataset.
parse_success_or_errorParse simple responses (success or error).
project_create_requestCreate request object for new projects.
project_replace_requestCreate request object for replacement of existing projects.
project_summary_responseDeserialize 'get_project' response object.
project_update_requestCreate request object to update existing projects.
replace_datasetReplace an existing dataset.
replace_insightReplace an insight.
replace_projectCreate a new project with a specific ID, replacing a project...
sdk_versionReturn the current dwapi version
sparqlExecute SPARQL query against a dataset.
sqlExecute SQL query against a dataset.
stop_on_insights_errorHandle a response containing an error by stopping execution...
success_messageDeserialize success response object.
syncFetch latest files from source and update dataset.
table_schema_field_responseDeserialize 'get_table_schema' fields.
table_schema_field_update_requestCreate request object for updating table schema fields.
table_schema_responseDeserialize 'get_table_schema' response object.
table_schema_update_requestCreate request object for updating table schema.
unlink_datasetUnlink a dataset from a project.
update_datasetUpdate an existing dataset.
update_insightUpdate an insight.
update_projectUpdate an existing project.
update_table_schemaUpdate table schema.
upload_data_frameUpload a data frame as a file to a dataset.
upload_fileUpload a single file to a dataset.
upload_filesUpload one or more files to a dataset.
user_agentReturn the dwapi user-agent
user_info_responseDeserialize 'get_user' response object.
dwapi documentation built on May 1, 2019, 11:18 p.m.