MTBonusFromQual: A convenience function to apply bonuses based on...
In andrewbrownphd/MetaTurkR: Functions to Support Metaresearch with MTurkR

Description Usage Arguments Details Value

This function applies bonuses depending on whether the bonus has been received by the worker previously for a given HITTypeId, assuming the worker achieves the threshold required by a given qualification (or qualifications).

MTBonusFromQual(HITTypeId = NULL, workerIds = NULL, assignmentIds = NULL,
  results = NULL, criteriaQuals = NULL, criteriaThresholds = NULL,
  bonusQual = NULL, bonusAmount = NULL,
  reason = "Thank you for completing these HITs!", sandbox = TRUE,
  verbose = FALSE, confirm = TRUE)

`HITTypeId`	A single HITTypeId. `"HITTypeId", "workerIds", and "assignmentIds"` XOR `"results"` must be specified.
`workerIds`	A single WorkerId or vector of WorkerIds. `"HITTypeId", "workerIds", and "assignmentIds"` XOR `"results"` must be specified.
`assignmentIds`	A single AssignmentId or vector of AssignmentIds. If specified, must be the same length as `"workerIds"`. `"HITTypeId", "workerIds", and "assignmentIds"` XOR `"results"` must be specified.
`results`	A data.frame returned from assignments returned by MTurk. `"HITTypeId", "workerIds", and "assignmentIds"` XOR `"results"` must be specified.
`criteriaQuals`	A single QualificationId or vector of QualificationIds.
`criteriaThresholds`	A single bonus threshold or vector of bonus thresholds. Must be the same length as `criteriaQuals`. The threshold means the worker must have a value greater than or equal to the threshold amount. Must be `numeric`.
`bonusQual`	The qualification ID for a qualification that counts how many bonuses have been given.
`bonusAmount`	The amount of money, in dollars, to be given to each worker.
`reason`	The reason to send the workers for receiving the bonus. Default is `"Thank you for completing these HITs!"`.
`sandbox`	Default is `TRUE`. Defines whether to work on live or sandbox Mechanical Turk site.
`verbose`	Defines whether additional output is printed to the console.
`confirm`	If `FALSE`, will not ask for confirmation before applying bonuses.

This function will grant bonuses if the worker has not received the bonus for the HITTypeId before and if the worker has a qualification score or qualification scores that exceed the thresholds. For example, if workers are assigned both a completion counter qualification that counts how many of a particular HITTypeId the worker has completed, and the worker is assigned a score of how well the worker did at completing the HITs based on gold standard or honey pot values, if the worker exceeds a threshold on the counter (e.g., completed at least 28 assignments) AND completed them with a score of at least 8500 points, the worker would receive the bonus.

Returns the WorkerIds of workers given the bonuses, or an invisible NULL if none granted.

andrewbrownphd/MetaTurkR documentation built on Nov. 23, 2019, 4:17 p.m.