report: Create a test report

Description Usage Arguments Details Value

Description

This function creates a report with the basic psychometrics

Usage

1
2
report(x, report_filename = "QME_report", output_format = "html_document",
  output_dir = NULL, simple_html = FALSE, ...)

Arguments

x

An analyze object

report_filename

The file name of the report (not including file extension, which is determined automatically)

output_format

One of "html_document", "word_document", or "pdf_document". Note that 'pdf_document' requires a working LaTeX implementation.

output_dir

The path to the directory that the report will be written to. If NULL, written to current working directory.

simple_html

If TRUE, overrides output_format and outputs a character object containing a simple (R Markdown v1) html report, useful for embedding in Shiny apps.

...

passed to render

Details

This reports contains number of items, number of examinees, a distribution of the total scores, reliability estimates (Coefficient Alpha, Guttman's L2, Guttman's L4, Feldt-Gilmer, and Feldt-Brennan), item overview (difficulty, point-biserial correlation, corrected point-biserial correlation, number of missing responses, and probability of missing responses), and distractor analysis.

Rendering is done by means of render from the rmarkdown package. See that help page for more details on the rendering process.

Value

If simple_html = FALSE, the default, generates report file as a side effect. If simple_html = TRUE, returns a string with the html of the report.


zief0002/QME documentation built on May 4, 2019, 11:22 p.m.