RegisterHITType: Register a HITType

In pyMTurkR: A Client for the 'MTurk' Requester API

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 = as.integer(2592000),
  qual.req = NULL,
  verbose = getOption("pyMTurkR.verbose", TRUE)
)

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 days.
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.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

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(), CreateHITType(), and createhittype() are aliases.

Value

A two-column data frame containing the HITTypeId of the newly registered HITType and an indicator for whether the registration request was valid.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference: Operation

See Also

CreateHIT

ChangeHITType

Examples

## Not run: 
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")

## End(Not run)

pyMTurkR documentation built on May 29, 2024, 6:13 a.m.