BlockWorker: Block/Unblock Worker(s)

In MTurkR: R Client for the MTurk Requester API

Description

Block or unblock a worker. This prevents a worker from completing any HITs for you while they are blocked, but does not affect their ability to complete work for other requesters or affect their worker statistics. GetBlockedWorkers retrieves your list of currently blocked workers.

Usage

BlockWorker(workers, reasons, verbose = getOption('MTurkR.verbose', TRUE), ...)

UnblockWorker(workers, reasons = NULL, verbose = getOption('MTurkR.verbose', TRUE), ...)

GetBlockedWorkers(pagenumber = NULL, pagesize = NULL, 
                  verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

workers	A character string containing a WorkerId, or a vector of character strings containing multiple WorkerIds.
reasons	A character string containing a reason for blocking or unblocking a worker. This must have length 1 or length equal to the number of workers. It is required for BlockWorker and optional for UnblockWorker.
pagenumber	An optional integer (or character string) indicating which page of Blocked Workers search results should be returned. Most users can ignore this.
pagesize	An optional integer (or character string) indicating how many Blocked Workers should be returned per page of results. Most users can ignore this and the function will return the first 65,535 blocks.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('MTurkR.verbose', TRUE).
...	Additional arguments passed to request.

Details

BlockWorker prevents the specified worker from completing any of your HITs. UnblockWorker reverses this operation.

GetBlockedWorkers retrieves currently blocked workers and the reason recorded for their block. This operation returns the first 65,535 blocked workers (the default for pagesize; access to additional blocked workers is available by specifying a pagenumber greater than 1.

BlockWorkers() and block() are aliases for BlockWorker. UnblockWorkers() and unblock() are aliases for UnblockWorker. blockedworkers() is an alias for GetBlockedWorkers.

Value

BlockWorker and UnblockWorker return a data frame containing the list of workers, reasons (for blocking/unblocking them), and whether the request to block/unblock each of them was valid.

GetBlockedWorkers returns a data frame containing the list of blocked workers and the recorded reason for the block.

Author(s)

Thomas J. Leeper

References

API Reference: Block

API Reference: Unblock

API Reference: GetBlockedWorkers

Examples

## Not run: 

BlockWorker(worker, reasons="Did not follow photo categorization HIT instructions.")
GetBlockedWorkers()
UnblockWorker(worker)

## End(Not run)

MTurkR documentation built on May 29, 2017, 11:09 p.m.