Description Usage Arguments Details Value Author(s) References See Also Examples
Get an assignment or multiple assignments for one or more HITs (or a HITType) as a data frame.
1 2 3 4 5 6 | 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), ...)
|
assignment |
An optional character string specifying the AssignmentId of an assignment to return. Must specify |
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 |
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 |
annotation |
An optional character string specifying the value of the |
status |
An optional character string (of “Approved”,“Rejected”,“Submitted”), specifying whether only a subset of assignments should be returned. If |
return.all |
If |
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 |
sortdirection |
Either “Ascending” or “Descending”. Ignored if |
response.group |
An optional character string (or vector of character strings) specifying what details to return. If |
return.assignment.dataframe |
A logical specifying whether the Assignment data frame should be returned. Default is |
verbose |
Optionally print the results of the API request to the standard output. Default is taken from |
... |
Additional arguments passed to |
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.
Optionally a data frame containing Assignment data, including workers responses to any questions specified in the question
parameter of the CreateHIT
function.
Thomas J. Leeper
API Reference: GetAssignmentsForHIT
1 2 3 4 5 6 7 8 9 10 11 12 | ## 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)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.