GetAssignment | R Documentation |
Get an assignment or multiple assignments for one or more HITs (or a HITType) as a data frame.
GetAssignment(
assignment = NULL,
hit = NULL,
hit.type = NULL,
annotation = NULL,
status = NULL,
results = as.integer(100),
pagetoken = NULL,
get.answers = FALSE,
persist.on.error = FALSE,
verbose = getOption("pyMTurkR.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 vector of character strings (containing one of more of
“Approved”,“Rejected”,“Submitted”), specifying whether
only a subset of assignments should be returned. If |
results |
An optional character string indicating how many results to fetch per page. Must be between 1 and 100. Most users can ignore this. |
pagetoken |
An optional character string indicating which page of search results to start at. Most users can ignore this. |
get.answers |
An optional logical indicating whether to also get the answers. If TRUE, the returned object is a list with Assignments and Answers. |
persist.on.error |
A boolean specifying whether to persist on an error. Errors can sometimes happen when the server times-out, in cases where large numbers of Assignments are being retrieved. |
verbose |
Optionally print the results of the API request to the
standard output. Default is taken from |
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()
, assignments()
,
and ListAssignmentsForHIT()
are aliases.
A data frame representing an assignment or multiple assignments for one or more HITs (or a HITType).
Tyler Burleigh, Thomas J. Leeper
API Reference: ListAssignmentsForHIT
## Not run:
# get an assignment
GetAssignment(assignments = "26XXH0JPPSI23H54YVG7BKLEXAMPLE")
# get all assignments for a HIT
GetAssignment(hit = "2MQB727M0IGF304GJ16S1F4VE3AYDQ")
# get all assignments for a HITType
GetAssignment(hit.type = "2FFNCWYB49F9BBJWA4SJUNST5OFSOW")
# 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.