dwapi (version 0.1.3.1)

add_file: Add a file to a request object.

Description

Add a file to a request object.

Usage

add_file(request, name, url, description = NULL, labels = NULL)
# S3 method for default
add_file(request, name, url, description = NULL,
  labels = NULL)
# S3 method for file_batch_update_request
add_file(request, name, url,
  description = NULL, labels = NULL)
# S3 method for dataset_create_request
add_file(request, name, url,
  description = NULL, labels = NULL)
# S3 method for dataset_replace_request
add_file(request, name, url,
  description = NULL, labels = NULL)
# S3 method for dataset_update_request
add_file(request, name, url = NULL,
  description = NULL, labels = NULL)

Arguments

request

Request object and container for files.

name

Filename including the file extension. If a file by that name already exists in the dataset, the file will be updated/overwritten.

url

Source URL for file. Optional, if updating existing files.

description

(optional) File description.

labels

(optional) List of file labels ("raw data", "documentation", "visualization", "clean data", "script" or "report").

Value

Modified request object.

Methods (by class)

• default: Default implementation

• file_batch_update_request: Add a file to a file_batch_update_request objects

• dataset_create_request: Add a file to a dataset_create_request object

• dataset_replace_request: Add a file to a dataset_replace_request object

• dataset_update_request: Add a file to a dataset_update_request object

Examples

# NOT RUN {
file_batch_update_req <- dwapi::file_batch_update_request()

file_batch_update_req <- dwapi::add_file(request = file_batch_update_req,
  name = 'file.csv', url = 'https://data.world/file3.csv')

dataset_create_req <- dwapi::dataset_create_request(title='coffeeCounty',
  visibility = 'OPEN', description = 'coffee county , AL - census income' ,
  tags = c('rsdk', 'sdk', 'arr') , license_string = 'Public Domain')

dataset_create_req <- dwapi::add_file(request = dataset_create_req,
  name = 'file4.csv', url = 'https://data.world/file4.csv')

dataset_replace_req <- dwapi::dataset_replace_request(visibility = 'OPEN',
  description = 'updated description', title = 'updated title', files = list())

dataset_replace_req <- dwapi::add_file(request = dataset_replace_req,
  name = 'file4.csv', url = 'https://data.world/file4.csv',
  description = "My 4th csv", labels = list("clean data"))
# }