report_get: Generate and retrieve job results

In cloudyr/crowdflower: R Client for the CrowdFlower API

Description

Results

Usage

report_get(id, report_type = c("full", "aggregated", "json", "gold_report",
  "workset", "source"), csv_args = list(stringsAsFactors = FALSE, check.names
  = FALSE), verbose = TRUE, ...)

report_regenerate(id, report_type = c("full", "aggregated", "json",
  "gold_report", "workset", "source"), verbose = TRUE, ...)

Arguments

id	A character string containing an ID for job.
report_type	Type of report
csv_args	A list of arguments passed to read.csv when report_type = 'source'.
verbose	A logical indicating whether to print additional information about the request.
...	Additional arguments passed to cf_query.

Details

report_get regenerates one of six types of reports within a job. Here is how they are described by Crowdflower:

• full: Returns the Full report containing every judgment.

• aggregated: Returns the Aggregated report containing the aggregated response for each row.

• json: Returns the JSON report containing the aggregated response, as well as the individual judgments, for the first 50 rows.

• gold_report: Returns the Test Question report.

• workset: Returns the Contributor report.

• source: Returns a CSV of the source data uploaded to the job.

Where possible, the package tries to return a data.frame of the results.

Value

If report_type = 'json', a list. Otherwise a data.frame.

References

Crowdflower API documentation

See Also

cf_account

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 for job
report_regenerate(id = j, report_type = "full")
report_get(id = j, report_type = "full")

# delete job
job_delete(j)

## End(Not run)

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