The first chunk of the report.qmd that render_report(format = "qmd")
writes calls this function. It reads the folder's .sframe and responses,
recomputes the analysis plan, and compares what it finds with the folder's
manifest.json. The report's Provenance section then states the
instrument hash and whether read_sframe() verified it, the amendments,
whether the responses file is the one exported, whether the analysis plan
results match the recorded results ("The analysis plan results match the
recorded results", or "differ" with both hashes), whether
report_results.json, references.json and interpretations.json are the
files exported, whether report.qmd was edited after surveyframe wrote it,
and which declared plan blocks the report includes. The plan results are
recomputed and compared with the record's hash in the manifest. The record
file itself is checked apart, so an edited or deleted record is reported
even though the numbers it held still match.
Arguments
- dir
The report source folder. Defaults to the working directory, which is the folder itself when Quarto renders its
report.qmd.- include_analysis
Logical. Whether the report includes the analysis plan results.
- plot_palette
"web"or"print", as inrender_report().
Value
A list the template reads: paths to the inputs it renders from, the
instrument hash, the analysis seed, and check, a list of the verdicts
(numbers_match, results_file_match, references_match,
interpretations_match, source_edited, responses_match, with the
recorded and recomputed hashes).
Details
Editing the .qmd stays allowed and is disclosed, as an amendment is.
Someone can delete the provenance chunk, as they can edit any document.
The tamper evidence a reviewer can check lives in the .sframe, the
responses hash and the results record, all checkable without the report.
See also
Other Report functions:
render_report(),
render_results(),
sframe_analysis_qmd(),
sframe_codebook(),
sframe_format_result(),
sframe_reports,
sframe_save_figures(),
sframe_show()
Examples
# \donttest{
d <- sframe_demo("likert_scale")
dir <- file.path(tempdir(), "report-source-example")
render_report(d$instrument, d$responses, output_file = dir, format = "qmd",
open = FALSE)
src <- sframe_report_source(dir)
src$check$numbers_match
src$check$source_edited
unlink(dir, recursive = TRUE)
# }