MTurkR (version 0.2)

CreateHIT: Create HIT

Description

Create a HIT. This is the most important function in the package. It creates a HIT based upon the specified parameters: (1) characteristics inherited from a HITType or specification of those parameters and (2) some kind of Question data structure.

Usage

CreateHIT(	hit.type = NULL, question = NULL, expiration, assignments = "1", 
			assignment.review.policy = NULL, hit.review.policy = NULL, 
			annotation = NULL, unique.request.token = NULL, 
			title = NULL, description = NULL, reward = NULL, duration = NULL, keywords = NULL, 
			auto.approval.delay = NULL, qual.req = NULL, 
			hitlayoutid = NULL, hitlayoutparameters = NULL, 
			response.group = NULL, keypair = credentials(), print = TRUE, 
			browser = FALSE, log.requests = TRUE, sandbox = FALSE)

Arguments

hit.type

An optional character string specifying the HITTypeId that this HIT should be visibly grouped with (and whose properties, e.g. reward amount, this HIT should inherit).

question

A mandatory (unless layoutid is specified) character string containing a QuestionForm, HTMLQuestion, or ExternalQuestion data structure. In lieu of a question parameter, a hitlayoutid and, optionally, hitlayoutparameters can be s

expiration

The time (in seconds) that the HIT should be available to workers. Must be between 30 and 31536000 seconds.

assignments

A character string specifying the number of assignments

assignment.review.policy

An optional character string containing an XML-formatted Assignment-level ReviewPolicy data structure. MTurkR currently does not provide functionality to generate a ReviewPolicy, but users who generate their own ReviewPolicy should be able to use this par

hit.review.policy

An optional character string containing an XML-formatted HIT-level ReviewPolicy data structure. MTurkR currently does not provide functionality to generate a ReviewPolicy, but users who generate their own ReviewPolicy should be able to use this parameter.

annotation

An optional character string annotating the HIT. This is not visible to workers, but can be used as a label by which to identify the HIT from the API.

unique.request.token

An optional character string, included only for advanced users.

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.

hitlayoutid

An optional character string including a HITLayoutId retrieved from a HIT template generated in the Requester User Interface, https://requester.mturk.com/hit_templates. If the HIT template includes variable placeholders, must also specify

hitlayoutparameters

An optional character string containing URL query parameter-formatted HITLayout parameters, for example returned by GenerateHITLayoutParameter. Must be specified along with a hitlay

response.group

An optional character string specifying what details of each HIT to return of: Minimal, HITQuestion, HITDetail, HITAssignmentSummary. For more information, see http://docs.amazonwebs

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.

Value

• A dataframe containing the HITId of the newly created HIT and other details as requested by the ResponseGroup option.

Details

This function creates a new HIT and makes it available to workers. Characteristics of the HIT can either be specified by including a valid HITTypeId for hit.type or creating a new HITType by atomically specifying the characteristics of a new HITType. When creating a HIT, some kind of Question data structure must be specified. Either, a QuestionForm, HTMLQuestion, or ExternalQuestion data structure can be specified for the question parameter or, if a HIT template created in the Requester User Interface (RUI) is being used, the appropriate hitlayoutid can be specified. If the HIT template contains variable placeholders, then the hitlayoutparameters should also be specified. When creating a ExternalQuestion HITs, the GenerateHITsFromTemplate function can emulate the HIT template functionality by converting a template .html file into a set of individual HIT .html files (that would also have to be uploaded to a web server) and executing CreateHIT for each of these external files with an appropriate ExternalQuestion data structure specified for the question parameter. createhit() and create() are aliases.

References

http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_CreateHITOperation.html{API Reference}

See Also

ExtendHIT ExpireHIT DisableHIT DisposeHIT

Examples

a <- GenerateLayoutParameter("message","Text to display in HIT")
CreateHIT(hit.type="2FFNCWYB49F9BBJWA4SJUNST5OFSOW",
hitlayoutid="23ZGOOGQSCM61T1H5H9U0U00OQWFFU", 
hitlayoutparameters=a)

b <- GenerateExternalQuestion("http://www.example.com/myhit.html","400")
CreateHIT(hit.type="2FFNCWYB49F9BBJWA4SJUNST5OFSOW", question=b)

CreateHIT(title="Survey",description="5 question survey",reward=".10",
duration=seconds(days=4),keywords="survey, questionnaire", question=b)