GetHIT: Get HIT

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

Description

Retrieve various details of a HIT as a data frame.

Usage

GetHIT(hit, verbose = getOption("pyMTurkR.verbose", TRUE))

Arguments

hit	A character string specifying the HITId of the HIT to be retrieved.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

Details

GetHIT retrieves characteristics of a HIT. HITStatus is a wrapper that retrieves the Number of Assignments Pending, Number of Assignments Available, Number of Assignments Completed for the HIT(s), which is helpful for checking on the progress of currently available HITs.

gethit() and hit() are aliases for GetHIT. status() is an alias for HITStatus.

Value

A list of data frames of various details of a HIT.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

Examples

## Not run: 
# register HITType
hittype <-
RegisterHITType(title="10 Question Survey",
                description=
                "Complete a 10-question survey about news coverage and your opinions",
                reward=".20",
                duration=seconds(hours=1),
                keywords="survey, questionnaire, politics")

a <- GenerateExternalQuestion("http://www.example.com/","400")
hit1 <-
CreateHIT(hit.type = hittype$HITTypeId, question = a$string)

GetHIT(hit1$HITId)
HITStatus(hit1$HITId)

# cleanup
DisableHIT(hit1$HITId)

## End(Not run)
## Not run: 
# Get the status of all HITs from a given batch from the RUI
HITStatus(annotation="BatchId:78382;")

## End(Not run)

pyMTurkR documentation built on Nov. 25, 2021, 9:07 a.m.