GetStatistic: MTurk Worker and Requester Statistics

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

Description

Get a requester statistic or a statistic for a particular worker. RequesterReport and WorkerReport provide wrappers that return all available statistics.

Usage

GetStatistic(statistic, period = "LifeToDate", count = NULL,
             response.group = NULL, 
             verbose = getOption('MTurkR.verbose', TRUE), ...)
RequesterReport(period = "LifeToDate", 
                verbose = getOption('MTurkR.verbose', TRUE), ...)

GetWorkerStatistic(worker, statistic, period = "LifeToDate", count = NULL,
                   response.group = NULL, 
                   verbose = getOption('MTurkR.verbose', TRUE), ...)
WorkerReport(worker, period = "LifeToDate", 
             verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

worker	A character string containing a WorkerId.
statistic	A character string containing the name of a statistic. Statistics can be retrieved from ListStatistics.
period	One of: “OneDay”, “SevenDays”, “ThirtyDays”, “LifeToDate”. Default is “LifeToDate”.
count	If period="OneDay", the number of days to return. Default is 1 (the most recent day).
response.group	An optional character string (or vector of character strings) specifying what details to return of “Request”, “Minimal”, or “Parameters”. For more information, see Common Parameters.
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 a specific requester or worker statistic. The list of available statistics can be retrieved by calling ListStatistics. Useful for monitoring workers or one's own use of the requester system.

statistic() is an alias for GetStatistic. workerstatistic() is an alias for GetWorkerStatistic.

Value

A data frame containing the Date, Value, and Statistic (and WorkerId, if GetWorkerStatistic or WorkerReport are called), and the value thereof. GetStatistic and GetWorkerStatistic return only information about the requested statistic as a data.frame. RequesterReport and WorkerReport return all of the requester and worker statistics, respectively, that are available in ListStatistics.

Author(s)

Thomas J. Leeper

References

API Reference: Requester Statistics

API Reference: Worker Statistics

See Also

ListStatistics

Examples

## Not run: 
GetStatistic("NumberHITsCompleted","OneDay")
RequesterReport("ThirtyDays")
GetWorkerStatistic("A1RO9UJNWXMU65","PercentHITsApproved","LifeToDate")
WorkerReport("A1RO9UJNWXMU65","SevenDays")

## End(Not run)

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