R/GetHIT.R

In leeper/MTurkR: R Client for the MTurk Requester API

GetHIT <-
gethit <-
hit <-
function(hit, response.group = NULL,
    return.hit.dataframe = TRUE, return.qual.dataframe = TRUE,
    verbose = getOption('MTurkR.verbose', TRUE), ...){
    operation <- "GetHIT"
    GETparameters <- paste("&HITId=", hit, sep = "")
    if (!is.null(response.group)) {
        if (any(!response.group %in% 
               c("Request", "Minimal", "HITDetail", "HITQuestion", "HITAssignmentSummary"))) {
            stop("ResponseGroup must be in c(Request,Minimal,HITDetail,HITQuestion,HITAssignmentSummary)")
        }
        if (length(response.group) == 1) {
            GETparameters <- paste(GETparameters, "&ResponseGroup=", 
                response.group, sep = "")
        } else {
            for (i in 1:length(response.group)) {
                GETparameters <- paste(GETparameters, "&ResponseGroup", 
                                       i - 1, "=", response.group[i], sep = "")
            }
        }
    }
    request <- request(operation, GETparameters = GETparameters, ...)
    if (is.null(request$valid)) {
        return(request)
    }
    if (request$valid == TRUE) {
        if ('sandbox' %in% names(list(...))) {
            sandbox <- list(...)$sandbox
        } else {
            sandbox <- getOption('MTurkR.sandbox')
        }
        z <- as.data.frame.HITs(xml.parsed = xmlParse(request$xml), 
                                return.qual.list = return.qual.dataframe,
                                sandbox = sandbox)
        if (verbose) {
            message("HIT (", hit, ") Retrieved")
        }
        if (return.hit.dataframe == TRUE & return.qual.dataframe == TRUE) {
            return.list <- list(HITs = z$HITs, QualificationRequirements = z$QualificationRequirements)
        } else if (return.hit.dataframe == TRUE & return.qual.dataframe == FALSE) {
            return.list <- list(HITs = z$HITs)
        } else if (return.hit.dataframe == FALSE & return.qual.dataframe == TRUE) {
            return.list <- list(QualificationRequirements = z$QualificationRequirements)
        } else {
            return.list <- list()
        }
    } else {
        if (verbose) {
            message("No HITs Retrieved")
        }
        return.list <- list()
    }
    return(return.list)
}