MTurkR (version 0.4)

RegisterHITType: Register a HITType

Description

Register a HITType on MTurk, in order to create one or more HITs to show up as a group to workers.

Usage

RegisterHITType(title, description, reward, duration, keywords = NULL, 
                auto.approval.delay = NULL, qual.req = NULL, 
                keypair = credentials(), print = getOption('MTurkR.print'),
                browser = getOption('MTurkR.browser'), 
                log.requests = getOption('MTurkR.log'),
                sandbox = getOption('MTurkR.sandbox'),
                validation.test = getOption('MTurkR.test'))

Arguments

title

A character string containing the title for the HITType. All HITs of this HITType will be visibly grouped to workers according to this title. Maximum of 128 characters.

description

A character string containing a description of the HITType. This is visible to workers. Maximum of 2000 characters.

reward

A character string containing the per-assignment reward amount, in U.S. Dollars (e.g., 0.15).

duration

A character string containing the amount of time workers have to complete an assignment for HITs of this HITType, in seconds (for example, as returned by seconds). Minimum of 30 seconds and maximum of 365 d

keywords

An optional character string containing a comma-separated set of keywords by which workers can search for HITs of this HITType. Maximum of 1000 characters.

auto.approval.delay

An optional character string specifying the amount of time, in seconds (for example, as returned by seconds), before a submitted assignment is automatically granted. Maximum of 30 days.

qual.req

An optional character string containing one or more QualificationRequirements data structures, for example as returned by GenerateQualificationRequirement.

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.

browser

Optionally open the request in the default web browser, rather than opening in R. Default is FALSE.

log.requests

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

sandbox

Optionally execute the request in the MTurk sandbox rather than the live server. Default is FALSE.

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

• A character string containing the HITTypeId of the newly registered HITType.

Details

All HITs of a given HITType are visibly grouped together for workers and share common properties (e.g., reward amount, QualificationRequirements). This function registers a HITType in the MTurk system, which can then be used when creating individual HITs. If a requester wants to change these properties for a specific HIT, the HIT should be changed to a new HITType (see ChangeHITType). hittype() is an alias.

References

http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_RegisterHITTypeOperation.html{API Reference: Operation} http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/Concepts_HITTypesArticle.html{API Reference: Concept}

See Also

CreateHIT ChangeHITType

Examples

RegisterHITType(title="10 Question Survey",
                description=
                "Complete a 10-question survey about news coverage and your opinions",
                reward=".20", 
                duration=seconds(hours=1), 
                keywords="survey, questionnaire, politics")