MTurkR (version 0.5)

ExpireHIT: Expire HIT

Description

Force a HIT to expire immediately, as opposed to at its prespecified expiration time. Expired HITs can be extended with the ExtendHIT operation.

Usage

ExpireHIT(hit = NULL, hit.type = NULL, verbose = getOption('MTurkR.verbose'), ...)

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).

verbose

Optionally print the results of the API request to the standard output. Default is taken from getOption('MturkR.verbose').

...

Additional arguments passed to request.

Value

A dataframe containing the HITId(s) and whether each expiration request was valid.

Details

A function to (prematurely) expire a HIT (or multiple HITs), thereby preventing any additional assignments from being completed. Pending assignments can still be submitted. An expired HIT can be reactived by adding additional time to its expiration using ExtendHIT.

expire() is an alias.

References

API Reference

See Also

CreateHIT

ExtendHIT

DisableHIT

DisposeHIT

Examples

# NOT RUN {
ExpireHIT(hit="2MQB727M0IGF304GJ16S1F4VE3AYDQ")
# }