GetFileUploadUrls
API endpoint was removed. As such the GetFileUpload()
function has been removed. (#125)GetAssignments()
would error when requesting HITs by HITTypeId and one of the HITs had no assignments. (h/t Tobias Heinrich)GetBonuses()
that created weird behavior when pagenumber
was specified along with return.all = TRUE
. (#123)GetAssignments()
now attempts to convert non-character variables to an appropriate R vector type via type.convert(, as.is = TRUE)
.GetStatistic()
and RequesterReport()
, including "NumberAssignmentsAvailable", "NumberAssignmentsAccepted", "NumberAssignmentsReturned", "TotalFeePayout", and "TotalRewardAndFeePayout". This is reflected in the return value of ListStatistics()
.? MTurkR
. (#93)GrantBonus()
allows the reason
argument to contain newlines and tabs. (#109)CreateQualificationType()
is called with validate.answerkey = TRUE
. (#117, h/t Darrell Penta)BulkCreateFromHITLayout()
that caused the function to fail. (#114, h/t Tyler Scott)GetBonuses()
. (#113, h/t Andrew Brown)credentials()
function. (h/t Kim Gross)GenerateExternalQuestion
now sets a default value of frame.height = 400
.ListQualificationTypes()
. (#104)credentials()
, and options("MTurkR.keypair")
are completely deprecated. A warning will now be issued if trying to supply credentials in this way. AWS credentials should be specified in environment variables AWS_ACCESS_KEY_ID
and AWS_SECRET_ACCESS_KEY
. Messages are triggered on package load if environment variables are not set. (#102)HITStatus()
will now display any non-empty RequesterAnnotation field for a HIT. (#101)print
, which was removed in v0.5, has been fully removed. Use verbose
instead. (#97)mturkrhelp
and APIReference
have been removed. (#96)MTurkR.Wizard
has been removed from MTurkR and has been recreated as a separate package called MTurkRGUI. (#95)HITStatus
now reports condensed column names better suited for narrow displays.response.group
arguments passed to HIT-related functions. (#89)authenticate
, which was deprecated in v0.5, is removed.credentials
, AWS credentials should be specified via environment variables AWS_ACCESS_KEY_ID
and AWS_SECRET_ACCESS_KEY
. credentials
will be deprecated.SufficientFunds()
reflects the new commission structure effective July 21, 2015. (#87)BulkCreateFromTemplate
and BulkCreateFromURLs
now have a frame.height
argument with a default of 450.GenerateHITReviewPolicy
and GenerateAssignmentReviewPolicy
was expanded and tested, and a related HTMLQuestion HIT template is now installed.request()
. (h/t Sean Murphy, #106)bringToTop(-1)
. This is fixed. (h/t Carolina Kuepper-Tetzel)BulkCreate
, BulkCreateFromTemplate
, BulkCreateFromURLs
, and BulkCreateFromHITLayout
functions that can be used to create multiple HITs of the same HITType with identical properties but different question content. The hitsfromtemplate
function has been removed. (#76)CreateHIT
now only warns about duplicated arguments (passing both hit.type
and arguments for RegisterHITType
) if verbose = TRUE
.AnswerKeyTemplate
) from a manually entered Qualification Test. (#73)GrantBonus
now accepts a unique.request.token
argument. (#75)format
argument to GenerateNotification
has been removed. (#71)AnswerKeyTemplate
.GrantQualification
and RejectQualification
has been merged to clarify the use of these functions. Documentation has been expanded with complete examples of both functions. (#72)GenerateQualificationRequirement
now notes that U.S. state locale values (following ISO 3166-2 format) are allows. (#74)GenerateHITsFromTemplate
now has a more complete example that includes an installed template HTML file. (#72)options
. (#83)GetStatistic
now consistently returns a three-column data frame containing the name of the requested statistic, its value, and the date of the statistic. If the request fails, this data frame has zero rows. Printing of request information (if verbose = TRUE
) has further been fixed to prevent incorrect printing when count
was specified. (#78)ExtendHIT
wherein specifying both add.assignments
and add.seconds
caused only assignments to be incremented. (#79)GetReviewResults
should now be able to return all results. This is untested due to the large page size of ReviewResults (65,535). (#54)ContactWorkers
function. (#53)mturkr.wizard
) has a significantly cleaned up code base aimed at simplifying future bug fixes. A user-visible side effect of this is modified aesthetics that should make the interface more attractive and more uniform. (#56)mturkr.wizard
now allows users to enter multiple WorkerIds for several functions by simply pasting one WorkerId per line into a multi-line textbox. (#52, h/t Justin Weigand)GetReviewResultsForHIT
now has pagenumber
and pagesize
arguments to control pagination of results. (#54)CreateHIT
and CreateQualificationType
now include examples using template files installed with the package. (#40)GetAssignments
only returned the first answer option when multiple selection answers were chosen by a worker. (#63, h/t Kyle Harms)ContactWorkers
batch mode that sent multiple emails to the same worker(s). (#58, h/t Andy Guess)as.data frame.QuestionForm
and as.data frame.AnswerKey
.GenerateReviewPolicy
is removed in lieu of two new functions: GenerateHITReviewPolicy
and GenerateAssignmentReviewPolicy
, both of which have a simplified function API and include extensive examples in the documentation. The previous code never worked correctly, so this change should be unimportant. The use of CreateHIT
remains unchanged. (#47)HITStatus
, ApproveAllAssignments
, ChangeHITType
, DisposeHIT
, DisableHIT
, ExpireHIT
, ExtendHIT
, GetAssignment
, GetBonuses
, SetHITAsReviewing
now include an optional annotation
argument that can be used to apply the function to all HITs of a given "batch" created in the online Requester User Interface. (#51)GetFileUpload
no longer has a file.ext
argument. Instead the file extension is taken from the uploaded file itself. The format of the filename for the downloaded file has also been clarified. (#45)wizard.simple
and mturkr.wizard
, the MTurkR interactive interfaces.SearchHITs
that was not passing ...
arguments ot GetQualificationType
SearchQualificationTypes
.GenerateQualifiationType
. (h/t Haotian Zhou)GenerateQualificationRequirement
now supports new comparators (given MTurk API update on 2014-07-17): "DoesNotExist", "In", and "NotIn". The "DoesNotExist" comparator allows requesters to effectively block workers who do not have, e.g., a requester-defined qualification. The "In" and "NotIn" comparators allow a boolean OR logical in QualificationRequirements (e.g., allowing a worker to be from the US or the UK) rather than having to create two separate HITs with different Locale restrictions.qual.number
argument to GenerateQualificationRequirement
has been removed.return.hit.dataframe
argument to GetHITsForQualificationType
has been removed.*ToDataFrame
have been replaced with as.data frame
S3 methods, which are handled by a global as.data frame.MTurkResponse
function. (#36)ParseErrorCodes
is removed (now used internally in request
).options('MTurkR.print')
is deleted and replaced by options('MTurkR.verbose')
. All functions will, temporarily, accept print
arguments. All code should be updated to reflect the new terminology moving forward.validation.test=TRUE
or browser=TRUE
, functions now return an object of class "MTurkResponse" for the purpose of debugging.options('MTurkR.browser')
is removed from all functions except request
. It can, however, still be passed via ...
to request
. (#38)APIReference
, mturkhelp
, and genericmturkr
are deprecated.GetBonuses
no longer supports the return.bonus.dataframe
logical. All bonuses are automatically returned. To just retrieve details on number of bonuses per HIT, request only the first page with page.number=1
and verbose=TRUE
.MTurkR.Wizard
now allows batch emails using ContactWorkers
. WorkerIds can be specified as a comma-separated list. (#4)credentials
function has now been changed to create and/or retrieve a global option MTurkR.keypair
. This is a backwards compatible change that allows users to specify options(MTurkR.keypair=c(accesskey, secretkey))
directly without using credentials
. All functions now point directly to the global option, so that credentials
can be deprecated in a future release.Valid
column (e.g., ContactWorkers
, etc.), Valid
is now a factor. (#28)ContactWorkers
in batch mode now returns a data frame identical in structure to using it in regular mode, with one row per worker. (#32)signature
argument to request
now defaults to NULL
and is generated automatically.HITsToDataFrame
(now as.data frame.HITs
) now returns, for the QualificationRequirements list element, an empty data frame rather a single NA
missing value if a given HIT does not have any QualificationRequirements attached to it.request
now generates the API authentication signature automatically, eliminating the need for authenticate
, which is deprecated. request
no longer accepts signature
or timestamp
arguments and has a new argument order. Arguments can be passed to request
via a new ...
argument in all functions.request
now uses curlPerform
instead of getURL
to gain finer control over API requests.request
now attempts to tryCatch
any errors on writing the MTurkR log file. (#9)request
now returns an object of S3 class "MTurkResponse" and an associated print method has been added.GenerateQualificationRequirement
now correctly handles the "Exists" comparator by requiring an empty character string for the corresponding value
argument.HITStatus
now prints correctly when only one HIT is retrieved.ApproveAllAssignments
now only attempts to approved assignments with AssignmentStatus "Submitted".as.data frame.QuestionForm
now returns "Overview" elements and "Question" elements as one data frame, distinguished by a new column: Element
. (#8)GetQualifications
and GetQualificationRequests
now respect the return.all
argument.return.qual.dataframe
argument in GetQualificationType
and GetQualifications
is removed.GetBonuses
whereby the default return.all=TRUE
argument overwrote manually specified pagenumber
and pagesize
arguments. When GetBonuses
is called with a hit.type
, return.all
is used recursively, such that return.all=FALSE
returns the requested page for each HIT of the requested HITType. (h/t Dane Wendell, #37)SendTestEventNotification
.GetBonuses
using a HITTypeId that caused the function to fail catastrophically.return.qual.dataframe
argument in GetQualificationType
and GetQualifications
is removed....
argument, the contents of which are passed to request
. (#38)browser
options are removed given removal of the feature from all functions.mturkhelp
and APIReference
now reflect deprecated status.authenticate
now reflect its deprecated status.request
has been updated to reflect its now non-exported status. request
notes that it no longer accepts signature
or timestamp
arguments, which are now generated internally. Documentation for ParseErrorCodes
is removed.add.seconds
parameter was incorrectly called add.time
in the ExtendHIT
documentation.hit.type
argument can now generally accept a vector of HITTypeIds rather than just a single character string. See documentation.GetBonuses
now allows requests to be opened in the default browser, like most other API functions.MTurkR.log
,MTurkR.test
,MTurkR.browser
,and MTurkR.print
) have been added to all functions. Defaults for these remain the same in all places.SearchHITs
returns a named list of QualificationRequirements. This is a consequence of some significant changes to now the names of user-defined QualificationTypes are added to this list (moving that functionality from QualificationRequirementsToDataFrame
to SearchHITs
.options('MTurkR.sandbox'=FALSE)
has been added to allow easier reuse of code between testing in the sandbox and the live server. The default behavior remains to use the live server, but using an option, which is called by all functions, allows one to toggle the global option and then recycle code verbatim.ListQualificationTypes
for the available types.cat
to warning
and message
, where appropriate.validation.test
parameter that, when TRUE, runs pre-query checks on the MTurkR call and returns the full API query URL. The call is not executed. This can be used for pre- or post-request debugging.options(MTurkR.logdir = getwd())
. The previous default behavior (to store the file in the working directory) is preserved but can now be globally modified for all requests. This might be useful for storing all requests (from all MTurk projects) in a single directory.ContactWorkers
now supplies additional information when attempting to contact ineligible workers (i.e., those who have not worked for the requester previously). These workers are indicated by a value of HardFailure
in the Valid
column of the response data frame. (#29)worker
, qual
, hit
, etc.) to character in order to prevent some unintended side effects. (#26)request
was returning errors due to this and has been updated. Everything is backwards compatible to earlier versions of libcurl. (#31, h/t James Ben Taylor)GenerateHITLayoutParameter
now replaces any non-XML ampersands with &
, which had previously caused failures when creating HITs. (#30, h/t Eric Lin)GetAssignment
, made a small change to prevent a warning and coercion of a one-assignment vector to a list. (h/t Eric Lin)HITStatus
and HITsToDataFrame
the correct capitalization of "Of" (from lower to upper) has been corrected throughout.GetAssignment
, AssignmentsToDataFrame
and QuestionFormAnswersToDataFrame
to handle Answer data structures with differing QuestionIdentifiers. (h/t Robert Vesco and Solomon Messing)response.group
options from GetHITsForQualificationType
due to personal communication with AWS.GetReviewableHITs
that correctly queried the API but returned an incomplete data frame. (h/t Eric Lin)CreateHIT
, saying type
was not defined, that occurred when hit.type
was non-NULL. (h/t Eric Lin)GetHIT
, which trickled down through HITsToDataFrame
and QualificationRequirementsToDataFrame
that caused error when retrieving HITs from the sandbox with user-defined qualifications. (h/t Eric Lin)GenerateHTMLQuestion
related to XML encoding. (h/t Alex Neustädter)request
and several convenience functions, corrected shell.exec
to browseURL
to be platform-independent.request
to handle a variety of problematic characters (that might emerge from FreeText responses in assignments). (h/t and contributions from Solomon Messing)shell.exec
and replaced with browseURL
.hit.type
parameters are now described (correctly) as allowing vectors of HITTypeIds rather than just a single HITTypeId. See documentation.ContactWorkers
now describes in greater detail what happens when attempting to contact ineligible workers. (#29)CreateHIT
now provides an option to validate the 'question' parameter for HTMLQuestion, ExternalQuestion, and QuestionForm HIT structures.CreateQualificationType
now provides options to validate the 'test' and/or 'answerkey' parameters for QuestionForm and AnswerKey structures, respectively.GenerateAnswerKey
was modified to accept slightly different inputs for the 'questions' parameter. A new function, AnswerKeyTemplate
, produces a user-modifiable template (as a list) for that parameter based on a QuestionForm data structure for which an AnswerKey is desired.XMLToDataFrame
) that normally return named lists have nothing to translate to a data frame, they now return named lists with NULL values rather than simply a single NULL.GetAssignments
that prevented the return of assignments for an entire HITType or for multiple HITs. Specifically, previous version was retrieving assignments via the API but not returning them to the user. (h/t Robert Vesco)HITsToDataFrame
, which is called by SearchHITs
, GetHIT
, etc., now uses the convenience function ListQualificationTypes
to return the name of QualificationRequirements when applicable.ContactWorkers
to allow a 'batch' mode, wherein workers are contacted with generic (i.e., not customized) email messages and subject lines in batches of 100.print=TRUE
modified slightly, so that iteration numbers are printed for each iteration (to monitor progress of mutli-item requests).CreateHIT
, GetAssignments
, GetHIT
, GetStatistic
, GetWorkerStatistic
, and SearchHITs
. These now include an optional "Request" ResponseGroup to simply return information about the API call without executing that call.AssignmentsToDataFrame
now returns a "RequesterFeedback" variable, providing access to feedback supplied to workers when GetAssignments
is called with the "AssignmentFeedback" ResponseGroup.GenerateAnswerKey
(see documentation) and a new function AnswerKeyToDataFrame
was released.QuestionFormToDataFrame
created. See documentation for details.BlockWorkers
to allow a single reason to be used for multiple workers, as originally intended.GetAssignments
to allow retrieval of assignments by status, as originally intended.AssignmentsToDataFrame
to correctly store 'ApprovalTime' or 'RejectionTime' in 'ApprovalRejectionTime'CreateQualificationType
related to parsing of XML in 'test' and 'answerkey' parameters.credentials
to pass CRAN checks.CreateQualificationType
notes web browser-dependent constraints on URL length that may produce unintended behavior when 'browser=TRUE' and a 'test' parameter is specified.AnswerKeyToDataFrame
.mturkr.wizard("simple")
.GenerateReviewPolicy
and retrieving their results using GetReviewResultsForHIT
.CreateQualificationType
.GetAssignments
, were producing unintended behavior.request
was modified to remove problematic whitespace characters when writing log entries (which made reading the log file into R problematic).Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.