GetQualifications: Get Qualifications

In pyMTurkR: A Client for the 'MTurk' Requester API

Get Qualifications

Description

Get all Qualifications of a particular QualificationType assigned to Workers.

Usage

GetQualifications(
  qual,
  status = NULL,
  results = as.integer(100),
  pagetoken = NULL,
  verbose = getOption("pyMTurkR.verbose", TRUE)
)

Arguments

qual	A character string containing a QualificationTypeId for a custom (i.e., not built-in) QualificationType.
status	An optional character string specifying whether only “Granted” or “Revoked” Qualifications should be returned.
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.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

Details

A function to retrieve Qualifications granted for the specified QualificationType. To retrieve a specific Qualification score (e.g., for one worker), use GetQualificationScore.

A practical use for this is with automatically granted QualificationTypes. After workers request and receive an automatically granted Qualification that is tied to one or more HITs, GetQualifications can be used to retrieve the WorkerIds for workers that are actively working on those HITs (even before they have submitted an assignment).

getquals() and ListWorkersWithQualificationType() are aliases.

Value

A data frame containing the QualificationTypeId, WorkerId, and Qualification scores of workers assigned the Qualification.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

See Also

GetQualificationScore

UpdateQualificationScore

Examples

## Not run: 
qual1 <- AssignQualification(workers = "A1RO9UJNWXMU65",
                    name = "Worked for me before",
                    description = "This qualification is for people who have worked for me before",
                    status = "Active",
                    keywords = "Worked for me before")

GetQualifications(qual1$QualificationTypeId)
RevokeQualification(qual1$QualificationTypeId, qual1$WorkerId)
GetQualifications(qual1$QualificationTypeId, status="Revoked")

DisposeQualificationType(qual1$QualificationTypeId)

## End(Not run)

pyMTurkR documentation built on May 29, 2024, 6:13 a.m.