getResults: Get results from Mechanical Turk

In RydenButler/labelR: Pairwise Data Labeling with Amazon's Mechanical Turk

Get results from Mechanical Turk

Description

getResults downloads completed work from MTurk for the specified HITs and can offer live progress updates on the amount of completed work.

Usage

getResults(
  current_hit_ids,
  current_document_ids,
  current_batch_id = 0,
  retry = TRUE,
  retry_in_seconds = 60,
  hit_categories = c("Document 1", "Document 2")
)

Arguments

current_hit_ids	A vector of HIT ids to be retieved.
current_document_ids	A 2-column matrix of document ids corresponding to the documents included in each HIT.
current_batch_id	An integer used to associate the current results with a desired batch
retry	A logical where TRUE causes the function to repeat until all results are downloaded, providing live progress updates throughout. When FALSE, the function will only download all currently available results for the specified HITs.
retry_in_seconds	An integer specifying how long the function should pause before retrying to collect results. Only applicable when retry = T.
hit_categories	A vector of strings with crowd classifier category names as they appear in the HITformat.html file. These should not be modified unless using a custom version of HITformat.html where alternate category names have been specified.

Details

The function retrieves and formats labeled data from MTurk.

Value

A list containing a data.frame of results from MTurk and a vector of HIT ids of incomplete HITs.

Author(s)

Ryden Butler

RydenButler/labelR documentation built on May 9, 2023, 5:52 a.m.