Learn R Programming

R Client for the MTurk Requester API

MTurkR provides programmatic access to the crowdsourcing functionality of the Amazon Mechanical Turk (MTurk) Requester API.

Amazon provides a helpful chart for deciding whether an API client (like MTurkR) is useful for your project.

Possible applications of the package include:

  • Survey or experimental research using MTurk workers as human subjects
  • Large-scale human coding or categorization of text, images, video, audio, or other files
  • Collection of unstructured data from the web
  • Audio and video transcription
  • Preprocessing of "messy" data prior to statistical procedures

The MTurkR documentation files contain minimal examples for all functions. Further examples of how to use MTurkR are provided in the MTurkR GitHub wiki. Users can contribute their own examples or further documentation there, or via pull requests to the GitHub repository.

Using MTurkR requires setting two environment variables: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. Specify them on the command-line before initializing the R session, or use Sys.setenv() within R, or place these values in an .Renviron or Rprofile.site file. (Note: Environment variables are more secure than the credentials() function or options("MTurkR.keypair") from earlier versions of MTurkR.)

As a supplemental feature to MTurkR, there is also a graphical user interface available for the package. A simple, command-line version of this is available using the wizard.simple() function in MTurkR. A more advanced GUI, built using Tcl/Tk, is available in MTurkRGUI package.

If you experience problems using MTurkR, you can:

Installation

To install the latest version from CRAN, simply use:

install.packages("MTurkR")

To install the latest development version of MTurkR from GitHub:

# latest stable version
install.packages("MTurkR", repos = c(getOption("repos"), "http://cloudyr.github.io/drat"))

# latest (unstable) version from GitHub
if (!require("ghit")) {
    install.packages("ghit")
}
ghit::install_github("cloudyr/MTurkR")

Copy Link

Version

Monthly Downloads

112

Version

0.8.0

License

GPL-2

Issues

Pull Requests

Stars

Forks

Last Published

May 23rd, 2019

Functions in MTurkR (0.8.0)

ContactWorker

Contact Worker(s)
credentials

Specify AWS Credentials
ApproveAssignment

Approve Assignment(s)
CreateQualificationType

Create QualificationType
CreateHIT

Create HIT
BulkCreate

Generate Multiple HITs
AssignQualification

Assign Qualification
AccountBalance

Retrieve MTurk account balance
ChangeHITType

Change HITType Properties of a HIT
Blocking Workers

Block/Unblock Worker(s)
GenerateAnswerKey

Generate AnswerKey Data Structure
DisableHIT

Disable HIT
DisposeQualificationType

Dispose QualificationType
DisposeHIT

Dispose HIT
GenerateHTMLQuestion

Generate HTMLQuestion
GenerateHITsFromTemplate

Generate HITs from a Template
ExtendHIT

Extend HIT
GenerateExternalQuestion

Generate ExternalQuestion
ExpireHIT

Expire HIT
GenerateHITLayoutParameter

Generate a HITLayout Parameter
GetQualificationRequests

Get Qualification Requests
GetHITsForQualificationType

Get HITs by Qualification
GetHIT

Get HIT
GetBonuses

Get Bonus Payments
GenerateNotification

Generate Notification
GetQualifications

Get Qualifications
GenerateQualificationRequirement

Generate QualificationRequirement
GenerateReviewPolicy

Generate HIT and/or Assignment ReviewPolicies
GetFileUpload

Get Files Uploaded by Workers
GetAssignment

Get Assignment(s)
GetReviewableHITs

Get Reviewable HITs
GrantQualification

Grant/Reject Qualification Request
GetReviewResultsForHIT

Get ReviewPolicy Results for a HIT
GetQualificationScore

Get a Worker's Qualification Score
readlogfile

Read the MTurkR Logfile
GetStatistic

MTurk Worker and Requester Statistics
MTurkR-package

R Client for the MTurk Requester API
GetQualificationType

Get QualificationType
Miscellaneous

Convenience Functions and RUI Interaction
GrantBonus

Pay Bonus to Worker
SearchHITs

Search your HITs
SendTestEventNotification

Test a Notification
seconds

Convert arbitrary times to seconds
SearchQualificationTypes

Search QualificationTypes
SetHITAsReviewing

Set HIT as “Reviewing”
RejectAssignment

Reject Assignment
RegisterHITType

Register a HITType
request

Execute an MTurk API Request
RevokeQualification

Revoke a Qualification from a Worker
SetHITTypeNotification

Configure a HITType Notification
Use Case: Scraping

Use Case: Scraping
Use Case: Categorization

Use Case: Categorization
wizard.simple

Interactive MTurkR Mode
XML

Parse MTurk XML to Data Frame
Use Case: Sentiment Analysis

Use Case: Sentiment Analysis
Use Case: Surveys

Use Case: Surveys
UpdateQualificationType

Update a Worker QualificationType
UpdateQualificationScore

Update a worker's score for a QualificationType