MTurkR (version 0.4)

DisableHIT: Disable HIT

Description

Disabling a HIT is probably not what you want to do. DisableHIT automatically removes the HIT from the MTurk server, approves (and thus pays for) all submitted and pending assignments, and then permanently deletes all assignment data.

Usage

DisableHIT(    hit = NULL, hit.type = NULL, response.group = NULL, 
            keypair = credentials(), print = getOption('MTurkR.print'),
            browser = getOption('MTurkR.browser'), 
            log.requests = getOption('MTurkR.log'),
            sandbox = getOption('MTurkR.sandbox'),
            validation.test = getOption('MTurkR.test'))

Arguments

hit

A character string containing a HITId or a vector of character strings containing multiple HITIds.

hit.type

An optional character string containing a HITTypeId (or a vector of HITTypeIds).

response.group

An optional character string specifying what details of each HIT to return of: Minimal, HITQuestion, HITDetail, HITAssignmentSummary. For more information, see http://docs.amazonwebs

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.

print

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.

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

• A dataframe containing a list of HITs and whether the request to disable each of them was valid.

Details

Disable a HIT (and its assignment data). This is a somewhat risky function because it automatically approves all pending assignments and then disposes of everything. DisposeHIT is probably what most users will use to delete HIT and assignment data that is no longer needed. disable() is an alias.

References

http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_DisableHITOperation.html{API Reference}

See Also

CreateHIT ExtendHIT ExpireHIT DisposeHIT

Examples

DisableHIT(hit="2MQB727M0IGF304GJ16S1F4VE3AYDQ")
DisableHIT(hit.type="2FFNCWYB49F9BBJWA4SJUNST5OFSOW")