Takes one result from run_analysis_plan() and returns what the report
shows for it: the formatted table with its caption and note, any second
table sframe_result_supplement() gives, the APA line, and the chart the
report picks for that method, with the instrument's labels. The table, the
chart and their choice per method come from the code render_report()
uses, so a host rendering results one at a time and the report agree.
Arguments
- result
One element of the list
run_analysis_plan()returns.- data
The response data the result was computed from. The chart is drawn from it, with the scales scored first as
run_analysis_plan()scores them wheninstrumentis given.- instrument
The
sframethe plan belongs to, orNULL. Gives the chart the item and choice labels the tables use.- palette
"web"(default) or"print", the report's 2 palettes. A palette given explicitly rebuilds the chart with it. Left out, the chart attached to the result is used as it is.- format
"html"(default) returns an HTML fragment with the chart embedded."png"and"svg"write the chart to a file as well, and return its path inchart_file.- width, height, dpi
The chart's size in inches and its resolution, for the embedded or written chart. Defaults 7 by 4.5 at 150 dpi.
Value
A list with block_id, test, caption, apa, table (a data
frame), note, supplement (a list with table and caption, or
NULL), chart (a ggplot, or NULL where the method has none or
ggplot2 is absent), html (the fragment, for format = "html"),
chart_file (for "png" and "svg") and syntax where the result has
one. A result that failed carries its
error, and html shows it.
Examples
# \donttest{
d <- sframe_demo("two_group")
res <- run_analysis_plan(d$responses, d$instrument)
out <- sframe_format_result(res[[1]], d$responses, d$instrument)
out$caption
out$table
# }