notify: Contact Contributors

In cloudyr/crowdflower: R Client for the CrowdFlower API

Description

Contact a contributor via email or pay a contributor a bonus in U.S. cents

Usage

job_contributor_bonus(id, contributor, amount, ...)

job_contributor_notify(id, contributor, msg, ...)

Arguments

id	A character string containing an ID for job to be updated.
contributor	A character string containing a contributor/contributor ID.
amount	A character string containing a bonus amount in U.S. cents.
...	Additional arguments passed to cf_query.
msg	A character string containing a message to be sent to the contributor.

Value

A character string containing the job ID, invisibly.

See Also

job_create, results_get, job_contributor_flag

Examples

## Not run: 
# create new job
f1 <- system.file("templates/instructions1.html", package = "crowdflower")
f2 <- system.file("templates/cml1.xml", package = "crowdflower")
j <- job_create(title = "Job Title", 
                instructions = readChar(f1, nchars = 1e8L),
                cml = readChar(f2, nchars = 1e8L))

# add data
d <- data.frame(variable = 1:3)
job_add_data(id = j, data = d)

# launch job
job_launch(id = j)

# get results
# get results for job
report_regenerate(id = j, report_type = "full")
r <- report_get(id = j, report_type = "full")

# Send message
job_contributor_notify(j, r[1, "_worker_id"], "Great work!")

# Pay bonus
job_contributor_bonus(j, r[1, "_worker_id"], "0.01")

# delete job
job_delete(j)

## End(Not run)

cloudyr/crowdflower documentation built on May 13, 2019, 8:20 p.m.