Learn R Programming

MTurkR (version 0.8.0)

GetReviewResultsForHIT: Get ReviewPolicy Results for a HIT

Description

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

Usage

GetReviewResultsForHIT(hit, assignment = NULL, policy.level = NULL,
                       retrieve.results = TRUE, retrieve.actions = TRUE,
                       return.all = FALSE, pagenumber = 1, pagesize = 400,
                       verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

hit

A character string containing a HITId.

assignment

An optional character string containing an AssignmentId. If specified, only results pertaining to that assignment will be returned.

policy.level

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

retrieve.results

Optionally retrieve ReviewResults. Default is TRUE.

retrieve.actions

Optionally retrieve ReviewActions. Default is TRUE.

return.all

A logical indicating whether all Qualifications (as opposed to a specified page of the search results) should be returned. Default is FALSE.

pagenumber

An optional character string indicating which page of search results should be returned. Most users can ignore this.

pagesize

An optional character string indicating how many search results should be returned by each request, between 1 and 400. Most users can ignore this.

verbose

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

...

Additional arguments passed to request.

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.

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 is an alias.

References

API Reference

API Reference (ReviewPolicies)

API Reference (Data Structure)

See Also

CreateHIT

GenerateHITReviewPolicy