MTurkR (version 0.5)

mturkhelp: Get some help

Description

Functions to obtain help with the MTurk API (as opposed to the MTurkR package itself). mturkrhelp makes help requests directly to the API, while APIReference simply loads the API documentation.

Usage

mturkhelp(about, helptype = NULL, keypair = getOption('MTurkR.keypair'),
          print = getOption('MTurkR.print'),
          log.requests = getOption('MTurkR.log'),
          validation.test = getOption('MTurkR.test'))
APIReference()

Arguments

about

A character string containing a help query.

helptype

Optionally either “Operation” or “ResponseGroup”.

keypair

A two-item character vector containing an AWS Access Key ID in the first position and the corresponding Secret Access Key in the second position. Set default with credentials.

print

Optionally print the results of the API request to the standard output. Default is TRUE.

log.requests

A logical specifying whether API requests should be logged. Default is TRUE. See readlogfile for details.

validation.test

A logical specifying whether only the pre-request checks should be conducted and the request URL returned (without executing the request). Default is FALSE.

Value

Nothing. For mturkhelp: help information is printed to the standard output. For APIReference: the MTurk API documentation is opened in the user's default browser.

Details

Some basic functions to get help with the MTurk API (as opposed to the MTurkR package). Whiel intended to be user-friendly, sophisticated use of MTurkR may require some understanding of hte MTurk API, which is easily accessed here.

References

Getting Started Guide

Developer Guide

API Reference

Quick Reference

Examples

# NOT RUN {
mturkhelp(about="GrantBonus",helptype="Operation")
APIReference()
# }