R: Generate individual reports on multipe choice test results
klausur.report
R Documentation
Generate individual reports on multipe choice test results
Description
klausur.report takes (at least) an object of class klausuR (or klausuR.mult) and a matriculation number to generate personal test results
in LaTeX and/or PDF format.
An object of class klausuR or klausuR.mult. To create reports from more than one object with the same configuration,
you can
also give them in one list here,
which will cause the function to call itself recursively.
matn
Matriculation number, "all" (produces individuall documents for all subjects),
"anon" (produces anonymous feedback)
or "glob" (produces a global results document).
save
Logical: If TRUE,
files are saved to disk (scheme: "path/matn.tex").
pdf
Logical: If TRUE, LaTeX reports will be converted to PDF automatically,
using texi2dvi.
If save is FALSE, a temporary directory is used,
that is only the PDF files will be saved.
path
Path for save and hist files.
file.name
File name scheme for the reports,
either "matn" (matriculation number) or "name" (name and firstname).
hist
A list with the logical elements points and marks: If TRUE,
the reports will include histograms
of the distribution of points and/or marks. The needed PDF files will be created by plot and saved as well.
(see path, hist.points and hist.marks).
hist.merge
If you need/want to combine results from several klausuR class objects for the histograms,
provide them all in a list here.
hist.points
File name for the histogram of points.
hist.marks
File name for the histogram of marks.
descr
Details on the test: List with the elements title (title of the test),
name (your name) and date.
marks.info
A list with the logical elements points and percent: If TRUE,
the reports will include a table showing
how marks were assigned to points achieved and/or percent solved, respectively.
lang
Set to "de" for reports in German, English is the default.
alt.candy
If TRUE,
a comma will be inserted for items with multiple alternatives ("235" becomes "2, 3, 5" in the printout)
anon.glob.file
If matn="anon" or matn="glob",
you can specify a filename for this particular report.
decreasing
Logical,
whether sorting of output should be done increasing or decreasing (only relevant for matn="anon" or
matn="glob").
sort.by
Character string naming a variable to sort the results by. Defaults to "Marks" (only relevant for matn="anon" or
matn="glob").
NRET.legend
Logical, If ET/NRET data is reported,
you can demand a legend in the table caption by setting this to true.
table.size
Character string to shrink the tables, must be one of "auto",
"normalsize", "small",
"footnotesize",
"scriptsize" or "tiny". The default table.size="auto" tries to decide between
"normalsize" and "footnotesize" to avoid pages with only one or two rows. If that fails,
try to manually set the size.
merge
Logical, if TRUE no individual PDFs will be saved,
but one large file with all reports. Uses the "pdfpages" package,
and only useful if pdf=TRUE as well.
quiet
Logical,
if TRUE no feedback messages on the current status are given.
Details
The report contains, next to the individual results,
a table with all given and correct answers (using xtable),
as well as nice histograms showing the distribution of the test results (points and/or marks are supportet). If the matriculation numer
is set to "all",
reports for all subjects are produced. Setting it to "anon" will get you a printable version of the anonymized results.
By default output is sent to standard out. To save them to disk in LaTeX format a "save" parameter is provided. Alternatively,
the reports
can be converted to PDF format as well. klausur.report is calling texi2dvi from the tools package for that.
If the object is of class klausuR.mult,
only the global results for tests with several test forms are evaluated. In case you'd rather like
reports on each test form,
call klausur.report with the single slots from that object accordingly.
Value
One or several LaTeX and/or PDF documents. If defined two histograms will be plotted.