MTurkR (version 0.6.17)

AccountBalance: Retrieve MTurk account balance

Description

Retrieves the amount of money (in US Dollars) in your MTurk account. SufficientFunds provides a wrapper that checks whether your account has sufficient funds based upon specified characters of your HIT.

Usage

AccountBalance(verbose = getOption('MTurkR.verbose', TRUE), ...)

SufficientFunds(amount = NULL, assignments = NULL, hits = NULL, 
                bonus.ct = NULL, bonus.amount = NULL, masters = FALSE, 
                turkfee = 0.2, turkmin = 0.01, mastersfee = 0.05, ...)

Arguments

amount

Intended per-assignment payment amount.

assignments

Number of intended assignments (per HIT, if multiple HITs).

hits

Number of HITs.

bonus.ct

Number of intended bonuses.

bonus.amount

Amount of each bonus.

masters

A logical indicating whether MTurk Masters will be used. Default is FALSE.

turkfee

Amazon's fee as percentage of payments. Default is 20-percent (as 0.20). Note, however, that MTurk charges an additional 20-percent if the number of assignments is greater than or equal to 10. This is factored in automatically

turkmin

Amazon's minimum per-assignment fee. Default is $0.01.

mastersfee

Amazon's additional charge for use of MTurk Masters. Default is 5-percent (as 0.05).

verbose

Optionally print the results of the API request to the standard output. Default is taken from getOption('MTurkR.verbose', TRUE).

...

Additional arguments passed to request.

Value

• Return value is an object of class MTurkResponse, including an additional character string (balance) containing the balance of the account in US Dollars. Note: object is returned invisibly.

Details

AccountBalance takes no substantive arguments. SufficientFunds is a wrapper for AccountBalance that accepts as inputs information about intended payments and bonuses to check whether your account has sufficient funds. If sandbox=TRUE, AccountBalance always returns $10,000.00. accountbalance() and getbalance() are aliases for AccountBalance.

References

http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_GetAccountBalanceOperation.html{API Reference} https://requester.mturk.com/pricing{MTurk Pricing Structure}

Examples

AccountBalance()
SufficientFunds(amount = ".25", assignments = "50", hits = "5")
SufficientFunds(bonus.ct = "150", bonus.amount = ".75")