SearchHITs: Search your HITs

In cloudyr/MTurkR: R Client for the MTurk Requester API

Description

Search for your HITs and return those HITs as R objects.

Usage

SearchHITs(response.group = NULL, return.all = TRUE, 
           pagenumber = "1", pagesize = "10", 
           sortproperty = "Enumeration", sortdirection = "Ascending", 
           return.hit.dataframe = TRUE, return.qual.dataframe = TRUE,
           verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

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.all	A logical indicating whether all HITs (as opposed to a specified page of the search results) should be returned. Default is TRUE.
pagenumber	An optional character string indicating which page of search results should be returned. Most users can ignore this.
pagesize	An optional character string indicating how many search results should be returned by each request, between 1 and 100. Most users can ignore this.
sortproperty	One of “Title”, “Reward”, “Expiration”, “CreationTime”, “Enumeration”. 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.
return.hit.dataframe	A logical indicating whether the data frame of HITs should be returned. Default is TRUE.
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 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

Retrieve your current HITs (and, optionally, characteristics thereof). To view HITs on the MTurk requester website, see OpenManageHITPage. To view HITs on the MTurk worker website, use ViewAvailableHITs.

searchhits() is an alias.

Value

A list one- or two-element list containing a data frame of HIT details and, optionally (if ‘return.qual.dataframe = TRUE'), a list of each HIT’s QualificationRequirements (stored as data frames in that list).

Author(s)

Thomas J. Leeper

References

API Reference

See Also

GetHIT

GetReviewableHITs

SearchQualificationTypes

ViewAvailableHITs

Examples

## Not run: 
SearchHITs()

## End(Not run)

cloudyr/MTurkR documentation built on June 4, 2019, 3:30 p.m.