SearchQualificationTypes: Search QualificationTypes

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

Description

Search for available QualificationTypes, including yours and others available on the MTurk system created by other requesters.

Usage

SearchQualificationTypes(query = NULL, only.mine = TRUE, only.requestable = FALSE, 
                         return.all = FALSE, pagenumber = "1", pagesize = "10", 
                         sortproperty = "Name", sortdirection = "Ascending", 
                         return.qual.dataframe = TRUE,
                         verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

query	An optional character string containing a search query to be used to search among available QualificationTypes.
only.mine	A logical indicating whether only your QualificationTypes should be returned (the default). If FALSE, QualificationTypes created by all requesters will be returned.
only.requestable	A logical indicating whether only requestable QualificationTypes should be returned. Default is FALSE.
return.all	A logical indicating whether all QualificationTypes (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	API currently only supports “Name”. Most users can ignore this.
sortdirection	Either “Ascending” or “Descending”. Ignored if return.all=TRUE. Most users can ignore this.
return.qual.dataframe	A logical indicating whether the QualificationTypes should be returned as a data frame. 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 available QualificationTypes, optionally only those QualificationTypes created by you and/or those that meet specific search criteria specified in the query parameter. Given that the total number of QualificationTypes available from all requesters could be infinitely large, specifying both only.mine=FALSE and return.all=FALSE will be time-consuming and may cause memory problems.

searchquals() is an alias.

Value

A data frame containing the QualificationTypeId of the newly created QualificationType and other details as specified in the request.

Author(s)

Thomas J. Leeper

References

API Reference

See Also

GetQualificationType

CreateQualificationType

UpdateQualificationType

DisposeQualificationType

SearchHITs

Examples

## Not run: 
SearchQualificationTypes(only.mine = TRUE, 
                         return.all = TRUE)
SearchQualificationTypes(query = "MIT", 
                         only.mine = FALSE,
                         return.all = FALSE)

## End(Not run)

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