GetFileUpload: Get Files Uploaded by Workers

Description

Get the URL for a file uploaded by a worker as part of a HIT, or download the file(s) directly to the working directory.

Usage

GetFileUpload(assignment, questionIdentifier, download = FALSE, file.ext = NULL, 
              open.file.in.browser = FALSE, keypair = credentials(),
              print = getOption('MTurkR.print'),
              browser = getOption('MTurkR.browser'),
              log.requests = getOption('MTurkR.log'),
              sandbox = getOption('MTurkR.sandbox'),
              validation.test = getOption('MTurkR.test'))

Arguments

assignment

A character string containing an AssignmentId, or a vector of character strings each containing an AssignmentId.

questionIdentifier

A question identifer for a file upload question, as specified in the question parameter of CreateHIT or in the placeholder of a HIT template created in the RUI.

download

A logical specifying whether the file(s) should be downloaded and saved in the working directory. Default is FALSE.

file.ext

An optional character string specifying the file extension of the uploaded files (used only if download=TRUE).

open.file.in.browser

A logical specifying whether the file should be opened in the user's default web browser.

keypair

A two-item character vector containing an AWS Access Key ID in the first position and the corresponding Secret Access Key in the second position. Set default with credentials.

Optionally print the results of the API request to the standard output. Default is TRUE.

browser

Optionally open the request in the default web browser, rather than opening in R. Default is FALSE.

log.requests

A logical specifying whether API requests should be logged. Default is TRUE. See readlogfile for details.

sandbox

Optionally execute the request in the MTurk sandbox rather than the live server. Default is FALSE.

validation.test

A logical specifying whether only the pre-request checks should be conducted and the request URL returned (without executing the request). Default is FALSE.

Value

Depending on the specification, either a character string containing a temporary URL (which lasts 60 seconds) where the uploaded file can be downloaded, or the files themselves are opened in the user's default web browser, or directly downloaded and saved to the working directory.} references{ href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetFileUploadURLOperation.html}{API Reference} } author{Thomas J. Leeper} %\note{} %\seealso{} examples{ dontrun{ GetFileUpload("26XXH0JPPSI23H54YVG7BKLO82DHNU","dictation",download=TRUE) } } keyword{Assignments}

Details

Note that a FileUploadURL is only valid for 60 seconds (per MTurk documentation), so URLs should either be retrieved one at a time or files should be automatically downloaded to the working directory with the download=TRUE. If browser=TRUE, request is executed in the user's default web browser, whereas if open.file.in.browser=TRUE, the request is executed in R and the file itself is opened in the browser. geturls() is an alias.