pyMTurkR-package: R Client for the MTurk Requester API

pyMTurkR-packageR Documentation

R Client for the MTurk Requester API

Description

This package provides access to the Amazon Mechanical Turk (MTurk) Requester API. The package provides users of the MTurk Requester User Interface with access to a variety of functions currently unavailable to them (the creation and maintenance of worker Qualifications, email notifications to workers through ContactWorker, automated reviewing of assignments using Review Policies, 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, and a simple, interactive command-line tool for performing many operations.

Most users will find themselves using three principal functions: CreateHIT, GetAssignments, and ApproveAssignments, to create one or more HITs on the MTurk server, to retrieve completed assignments, and to approve assignments (and thus pay workers), respectively. As task complexity increases, additional functions are provided to handle worker qualifications, bonuses, emails to workers, automated review policies, bulk creation of HITs, and so forth.

Critically important, nothing in pyMTurkR will work during a given session without either first setting AWS credentials. The easiest way to do this is to specify ‘⁠AWS_ACCESS_KEY_ID⁠’ and ‘⁠AWS_SECRET_ACCESS_KEY⁠’ environment variables using Sys.setenv() or by placing these values in an .Renviron file. Credentials can also be specified in an AWS CLI credentials file as described here.

This package is a reboot of the MTurkR package after the MTurk API was updated in June 2019 and rendered it obsolete. This package uses reticulate to wrap boto3, the AWS SDK for Python, and access the MTurk API functions.

Author(s)

Tyler Burleigh

Maintainer: Tyler Burleigh <tylerburleigh@gmail.com>

References

Amazon Mechanical Turk

Amazon Mechanical Turk API Documentation

See Also

To get started using pyMTurkR, see the documentation for CreateHIT (for creating single tasks). For some tutorials on how to use MTurkR for specific use cases, see the following:


pyMTurkR documentation built on May 29, 2024, 6:13 a.m.