GetAssignment: Get Assignment(s)

In MTurkR: R Client for the MTurk Requester API

Description

Get an assignment or multiple assignments for one or more HITs (or a HITType) as a data frame.

Usage

GetAssignment(assignment = NULL, hit = NULL, hit.type = NULL, 
              annotation = NULL, status = NULL, 
              return.all = FALSE, pagenumber = "1", pagesize = "10", 
              sortproperty = "SubmitTime", sortdirection = "Ascending", 
              response.group = NULL, return.assignment.dataframe = TRUE,
              verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

assignment	An optional character string specifying the AssignmentId of an assignment to return. Must specify assignment xor hit xor hit.type xor annotation.
hit	An optional character string specifying the HITId whose assignments are to be returned, or a vector of character strings specifying multiple HITIds all of whose assignments are to be returned. Must specify assignment xor hit xor hit.type xor annotation.
hit.type	An optional character string specifying the HITTypeId (or a vector of HITTypeIds) of one or more HITs whose assignments are to be returned. Must specify assignment xor hit xor hit.type xor annotation.
annotation	An optional character string specifying the value of the RequesterAnnotation field for a batch of HITs. This can be used to retrieve all assignments for all HITs from a “batch” created in the online Requester User Interface (RUI). To use a batch ID, the batch must be written in a character string of the form “BatchId:78382;”, where “73832” is the batch ID shown in the RUI. Must specify assignment xor hit xor hit.type xor annotation.
status	An optional character string (of “Approved”,“Rejected”,“Submitted”), specifying whether only a subset of assignments should be returned. If NULL, all assignments are returned (the default). Only applies when hit or hit.type are specified; ignored otherwise.
return.all	If TRUE, all available assignments are returned. Otherwise, only assignments falling within the specified pagenumber and pagesize search results are returned.
pagenumber	An optional character string indicating which page of search results should be returned (only appropriate when specifying a single HITId). Most users can ignore this.
pagesize	An optional character string indicating how many search results should be returned by each request (only appropriate when specifying a single HITId), between 1 and 100. Most users can ignore this.
sortproperty	One of “AcceptTime”, “SubmitTime”, “AssignmentStatus”. Ignored if return.all=TRUE. Most users can ignore this.
sortdirection	Either “Ascending” or “Descending”. Ignored if return.all=TRUE. Most users can ignore this.
response.group	An optional character string (or vector of character strings) specifying what details to return. If assignment is specified, response.group can include any of “Request”, “Minimal”, “AssignmentFeedback”, “HITDetail”, and/or “HITQuestion”. If hit or hit.type is specified, response.group can include “Request”, “Minimal”, and/or “AssignmentFeedback”. For more information, see Common Parameters.
return.assignment.dataframe	A logical specifying whether the Assignment data frame should be returned. Default is TRUE.
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

This function returns the requested assignments. The function must specify an AssignmentId xor a HITId xor a HITTypeId. If an AssignmentId is specified, only that assignment is returned. If a HIT or HITType is specified, default behavior is to return all assignments through a series of sequential (but invisible) API calls meaning that returning large numbers of assignments (or assignments for a large number of HITs in a single request) may be time consuming.

GetAssignments(), assignment(), and assignments() are aliases.

Value

Optionally a data frame containing Assignment data, including workers responses to any questions specified in the question parameter of the CreateHIT function.

Author(s)

Thomas J. Leeper

References

API Reference: GetAssignment

API Reference: GetAssignmentsForHIT

See Also

GetHIT

ApproveAssignment

ApproveAllAssignments

RejectAssignment

Examples

## Not run: 
# get an assignment
GetAssignment(assignments="26XXH0JPPSI23H54YVG7BKLEXAMPLE")
# get all assignments for a HIT
GetAssignment(hit="2MQB727M0IGF304GJ16S1F4VE3AYDQ", return.all=TRUE)
# get all assignments for a HITType
GetAssignment(hit.type="2FFNCWYB49F9BBJWA4SJUNST5OFSOW",
              return.all=FALSE, pagenumber="1", pagesize="50")
# get all assignments for an online batch from the RUI
GetAssignment(annotation="BatchId:78382;")

## End(Not run)

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