GetHIT: Get HIT

Description

Retrieve various details of a HIT as a dataframe. What details are returned depend upon the requested ResponseGroup.

Usage

GetHIT(hit, response.group = NULL, keypair = credentials(),
       print = getOption('MTurkR.print'), 
       browser = getOption('MTurkR.browser'),
       log.requests = getOption('MTurkR.log'),
       sandbox = getOption('MTurkR.sandbox'), 
       return.hit.dataframe = TRUE, return.qual.dataframe = TRUE,
       validation.test = getOption('MTurkR.test'))

HITStatus(hit = NULL, hit.type = NULL, keypair = credentials(),
          print = getOption('MTurkR.print'), 
          log.requests = getOption('MTurkR.log'),
          sandbox = getOption('MTurkR.sandbox'))

Arguments

hit

An optional character string specifying the HITId of the HIT to be retrieved. Must specify hit xor hit.type.

hit.type

An optional character string specifying the HITTypeId (or a vector of HITTypeIds) of the HIT(s) to be retrieved. Must specify hit xor hit.type.

response.group

An optional character string (or vector of character strings) specifying what details of each HIT to return of: Request, Minimal, HITDetail, HITQuestion, HITAssignmentSummary

keypair

A two-item character vector containing an AWS Access Key ID in the first position and the corresponding Secret Access Key in the second position. Set default with credentials.

Optionally print the results of the API request to the standard output. Default is TRUE.

browser

Optionally open the request in the default web browser, rather than opening in R. Default is FALSE.

log.requests

A logical specifying whether API requests should be logged. Default is TRUE. See readlogfile for details.

sandbox

Optionally execute the request in the MTurk sandbox rather than the live server. Default is FALSE.

return.hit.dataframe

A logical indicating whether the dataframe of HITs should be returned. Default is TRUE.

return.qual.dataframe

A logical indicating whether the list of each HIT's QualificationRequirements (stored as dataframes in that list) should be returned. Default is TRUE.

validation.test

A logical specifying whether only the pre-request checks should be conducted and the request URL returned (without executing the request). Default is FALSE.

Value

Optionally a dataframe containing the HITs and a list of each HIT's QualificationRequirements (stored as dataframes in that list in the order that HITs were retrieved.). The exact characteristics of each HIT returned depend upon the code{response.group} parameter.} references{ href{http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetHITOperation.html}{API Reference} } author{Thomas J. Leeper} %\note{} seealso{ code{GetHITsForQualificationType} code{GetReviewableHITs} code{SearchHITs} } examples{ dontrun{ GetHIT("2MQB727M0IGF304GJ16S1F4VE3AYDQ") HITStatus("2MQB727M0IGF304GJ16S1F4VE3AYDQ") hits <- c("2MQB727M0IGF304GJ16S1F4VE3AYDQ","AM4DB727M0IGF304GJ16S1F4VE36JIQ") HITStatus(hits) } } keyword{HITs}

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. Specifying a hit.type causes the function to first search for avialable HITs of that HITType, then return the requested information for each HIT. gethit() and hit() are aliases for GetHIT. status() is an alias for HITStatus.