Learn R Programming

MTurkR (version 0.5.1)

MTurkR-package: Access to the Amazon Mechanical Turk (MTurk) API via R.

Description

This package provides access to the Amazon Mechanical Turk (MTurk) API via R, including all the basic API calls, plus additional wrappers to simplify multiple sequential calls and transform the XML returned by the API requests into R data structures (especially, dataframes). The package provides users of the MTurk Requester User Interface (RUI) with access to a variety of functions currently unavailable to them (the creation and maintenance of worker Qualifications, email notifications to workers through ContactWorker, and streamlined bonus payments through GrantBonus). It also provides users with all functions available in the RUI directly in R as well as a large number of other functions, with a relatively simple command-line interface. The core functionality is enacted through request and authenticate, though most users are unlikely to use these functions directly. (And, the needs of even advanced users can probably be satisfied by the functionality of request for making arbitrary API requests.) Instead, most users will find themselves using four principal functions: credentials, CreateHIT, GetAssignments, and ApproveAssignments, to define one's MTurk (AWS) credentials, to create one or more HITs on the MTurk server, to retrieve completed assignments, and to approve assignments (and thus pay workers), respectively. Critically important, nothing in MTurkR will work during a given session without either first setting AWS credentials with the credentials function or specifying those credentials atomically within each function. There are five common parameters that can be specified in most MTurkR functions: keypair, print, log.requests, and sandbox. The first of these is the AWS credentials parameter just described (whose default can be set globally with credentials), and the latter four are logicals. print causes certain information to be displayed on the standard output when functions are executed. log.requests records details of API calls in the working directory (see readlogfile). Setting the parameter sandbox=TRUE executes requests in the developer sandbox rather than the live server. This can be set globally with options('MTurkR.sandbox'), where the default is FALSE. A lightweight menu-based Wizard (called by MTurkR.Wizard) is also available for beginners to interactively connect with MTurk. The wizard is designed to quickly create HITs, approve and reject work, contact or bonus workers, grant Qualifications, and so forth. While helpful, the wizard is intended only to facilitate beginners and is not intended to mimic anything near the full functionality of individual MTurkR functions.

Arguments

References

http://leeper.github.io/MTurkR/{MTurkR homepage} http://www.mturk.com{Amazon Mechanical Turk} http://aws.amazon.com/documentation/mturk/{Amazon Mechanical Turk API Documentation}