AssignQualification: Assign Qualification

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

Assign Qualification

Description

Assign a Qualification to one or more workers. The QualificationType should have already been created by CreateQualificationType, or the details of a new QualificationType can be specified atomically. This function also provides various options for automatically specifying the value of a worker's QualificationScore based upon a worker's statistics.

Usage

AssignQualification(
  qual = NULL,
  workers,
  value = 1,
  notify = FALSE,
  name = NULL,
  description = NULL,
  keywords = NULL,
  status = NULL,
  retry.delay = NULL,
  test = NULL,
  answerkey = NULL,
  test.duration = NULL,
  auto = NULL,
  auto.value = NULL,
  verbose = getOption("pyMTurkR.verbose", TRUE)
)

Arguments

qual	A character string containing a QualificationTypeId.
workers	A character string containing a WorkerId, or a vector of character strings containing multiple WorkerIds.
value	A character string containing the value to be assigned to the worker(s) for the QualificationType.
notify	A logical indicating whether workers should be notified that they have been assigned the qualification. Default is FALSE.
name	An optional character string specifying a name for a new QualificationType. This is visible to workers. Cannot be modified by UpdateQualificationType.
description	An optional character string specifying a longer description of the QualificationType. This is visible to workers. Maximum of 2000 characters.
keywords	An optional character string containing a comma-separated set of keywords by which workers can search for the QualificationType. Cannot be modified by UpdateQualificationType. Maximum of 1000 characters.
status	A character vector of “Active” or “Inactive”, indicating whether the QualificationType should be active and visible.
retry.delay	An optional time (in seconds) indicating how long workers have to wait before requesting the QualificationType after an initial rejection.
test	An optional character string consisting of a QuestionForm data structure, used as a test a worker must complete before the QualificationType is granted to them.
answerkey	An optional character string consisting of an AnswerKey data structure, used to automatically score the test.
test.duration	An optional time (in seconds) indicating how long workers have to complete the test.
auto	A logical indicating whether the Qualification is automatically granted to workers who request it. Default is FALSE.
auto.value	An optional parameter specifying the value that is automatically assigned to workers when they request it (if the Qualification is automatically granted).
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

Details

A very robust function to assign a Qualification to one or more workers. The simplest use of the function is to assign a Qualification of the specified value to one worker, but assignment to multiple workers is possible. Workers can be assigned a Qualification previously created by CreateQualificationType, with the characteristics of a new QualificationType specified atomically, or a QualificationTypeID for a qualification created in the MTurk RUI.

AssignQualifications(), assignqual() and AssociateQualificationWithWorker() are aliases.

Value

A data frame containing the list of workers, the QualificationTypeId, the value each worker was assigned, whether they were notified of their QualificationType assignment, and whether the request was valid.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

Examples

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

# assign qualification to single worker
AssignQualification(qual1$QualificationTypeId, "A1RO9UJNWXMU65", value = "50")

# delete the qualification
DeleteQualificationType(qual1)

# assign a new qualification (defined atomically)
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")

## End(Not run)

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