Description Usage Arguments Details Value Author(s) References See Also Examples
Retrieve various details of a HIT as a data frame. What details are returned depend upon the requested ResponseGroup.
1 2 3 4 5 6 |
hit |
An optional character string specifying the HITId of the HIT to be retrieved. Must specify |
hit.type |
An optional character string specifying the HITTypeId (or a vector of HITTypeIds) of the HIT(s) to be retrieved. Must specify |
annotation |
An optional character string specifying the value of the |
response.group |
An optional character string (or vector of character strings) specifying what details of each HIT to return of: “Request”, “Minimal”, “HITDetail”, “HITQuestion”, “HITAssignmentSummary”. For more information, see Common Parameters and HIT Data Structure. |
return.hit.dataframe |
A logical indicating whether the data frame of HITs should be returned. Default is |
return.qual.dataframe |
A logical indicating whether the list of each HIT's QualificationRequirements (stored as data frames in that list) 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 |
GetHIT
retrieves characteristics of a HIT. HITStatus
is a wrapper that retrieves the Number of Assignments Pending, Number of Assignments Available, Number of Assignments Completed for the HIT(s), which is helpful for checking on the progress of currently available HITs. Specifying a hit.type
causes the function to first search for available HITs of that HITType, then return the requested information for each HIT.
gethit()
and hit()
are aliases for GetHIT
. status()
is an alias for HITStatus
.
Optionally a one- or two-element list containing a data frame of HIT details and, optionally, a list of each HIT's QualificationRequirements (stored as data frames in that list in the order that HITs were retrieved.).
Thomas J. Leeper
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | ## Not run:
# register HITType
hittype <-
RegisterHITType(title="10 Question Survey",
description=
"Complete a 10-question survey about news coverage and your opinions",
reward=".20",
duration=seconds(hours=1),
keywords="survey, questionnaire, politics")
a <- GenerateExternalQuestion("http://www.example.com/","400")
hit1 <-
CreateHIT(hit.type = hittype$HITTypeId, question = a$string)
GetHIT(hit1$HITId)
HITStatus(hit1$HITId)
# cleanup
DisableHIT(hit1$HITId)
## End(Not run)
## Not run:
# Get the status of all HITs from a given batch from the RUI
HITStatus(annotation="BatchId:78382;")
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.