userfriendlyscience (version 0.1-2)

itemInspection: itemInspection

Description

Function to generate a PDF with four panels per page, showing some basic item characteristics.

Usage

itemInspection(dat, items,
               docTitle = "Scale inspection", docAuthor = "Author",
               pdfLaTexPath, rnwPath, filename="itemInspection",
               convertFactors = TRUE, digits=4)

Arguments

dat

Dataframe containing the items of the relevant scale

items

Either a character vector with the itemnames, or, if the items are organised in scales, a list of character vectors with the items in each scale.

docTitle

Title to use when generating the PDF.

docAuthor

Author(s) to include when generating the PDF.

pdfLaTexPath

The path to PdfLaTex. This file is part of a LaTeX installation that creates a pdf out of a .tex file. In Windows, you can download (portable) MikTex from http://miktex.org/portable. You then decide yourself where to install MikTex; pdflatex will end

rnwPath

The path where the temporary files and the resulting PDF should be stored.

filename

The filename to use to save the pdf.

convertFactors

Whether to convert factors to numeric vectors for the analysis.

digits

The number of digits to use in the tables.

Value

• This function returns nothing; it just generates a PDF.

Examples

itemInspection(mtcars, items=c('disp', 'hp', 'drat'), pdfLaTexPath="valid/path/here");