GetReviewResultsForHIT: Get ReviewPolicy Results for a HIT

GetReviewResultsForHITR Documentation

Get ReviewPolicy Results for a HIT

Description

Get HIT- and/or Assignment-level ReviewPolicy Results for a HIT

Usage

GetReviewResultsForHIT(
  hit,
  policy.level = NULL,
  results = as.integer(100),
  pagetoken = NULL,
  verbose = getOption("pyMTurkR.verbose", TRUE)
)

Arguments

hit

A character string containing a HITId.

policy.level

Either HIT or Assignment. If NULL (the default), all data for both policy levels is retrieved.

results

An optional character string indicating how many results to fetch per page. Must be between 1 and 100. Most users can ignore this.

pagetoken

An optional character string indicating which page of search results to start at. Most users can ignore this.

verbose

Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

Details

A simple function to return the results of a ReviewPolicy. This is intended only for advanced users, who should reference MTurk documentation for further information or see the notes in GenerateHITReviewPolicy.

reviewresults and ListReviewPolicyResultsForHIT are aliases.

Value

A four-element list containing up to four named data frames, depending on what ReviewPolicy (or ReviewPolicies) were attached to the HIT and whether results or actions are requested: AssignmentReviewResult, AssignmentReviewAction, HITReviewResult, and/or HITReviewAction.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

API Reference (ReviewPolicies)

API Reference (Data Structure)

See Also

CreateHIT

GenerateHITReviewPolicy


cloudyr/pyMTurkR documentation built on April 7, 2024, 12:07 p.m.