SetHITAsReviewing: Set HIT as "Reviewing"

In pyMTurkR: A Client for the 'MTurk' Requester API

Set HIT as “Reviewing”

Description

Update the review status of a HIT, from “Reviewable” to “Reviewing” or the reverse.

Usage

SetHITAsReviewing(
  hit = NULL,
  hit.type = NULL,
  annotation = NULL,
  revert = FALSE,
  verbose = getOption("pyMTurkR.verbose", TRUE)
)

Arguments

hit	An optional character string containing a HITId, or a vector character strings containing HITIds, whose status are to be changed. Must specify hit xor hit.type xor annotation.
hit.type	An optional character string specifying a HITTypeId (or a vector of HITTypeIds), all the HITs of which should be set as “Reviewing” (or the reverse). Must specify hit xor hit.type xor annotation.
annotation	An optional character string specifying the value of the RequesterAnnotation field for a batch of HITs. This can be used to set the review status all HITs from a “batch” created in the online Requester User Interface (RUI). To use a batch ID, the batch must be written in a character string of the form “BatchId:78382;”, where “73832” is the batch ID shown in the RUI. Must specify hit xor hit.type xor annotation.
revert	An optional logical to revert the HIT from “Reviewing” to “Reviewable”.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

Details

A function to change the status of one or more HITs (or all HITs of a given HITType) to “Reviewing” or the reverse. This affects what HITs are returned by GetReviewableHITs. Must specify a HITId xor a HITTypeId xor an annotation.

reviewing() and UpdateHITReviewStatus() are aliases.

Value

A data frame containing HITId, status, and whether the request to change the status of each was valid.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

See Also

GetReviewableHITs

Examples

## Not run: 

a <- GenerateExternalQuestion("https://www.example.com/", "400")
hit1 <- CreateHIT(hit.type = "2FFNCWYB49F9BBJWA4SJUNST5OFSOW",
                  question = a$string,
                  expiration = seconds(hours = 1))
SetHITAsReviewing(hit1$HITId)

# cleanup
DisableHIT(hit1$HITId)


## End(Not run)

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