scaleDiagnosisToPDF: scaleDiagnosisToPDF

In userfriendlyscience: Quantitative Analysis Made Accessible

Description

scaleDiagnosis provides a number of diagnostics for a scale (an aggregative measure consisting of several items), and scaleDiagnosisToPDF takes the resulting object and generates a PDF file, which is then saved to disk.

Usage

scaleDiagnosisToPDF(scaleDiagnosisObject,
                    docTitle = "Scale diagnosis", docAuthor = "Author",
                    pdfLatexPath, rnwPath=getwd(),
                    filename = "scaleDiagnosis",
                    digits=2,
                    rMatrixColsLandscape = 6,
                    pboxWidthMultiplier = 1,
                    scatterPlotBaseSize = 4,
                    maxScatterPlotSize = NULL,
                    pageMargins=15,
                    pval=TRUE)

Arguments

scaleDiagnosisObject	An object generated by scaleDiagnosis.
docTitle	The title of the PDF file (printed on the first page).
docAuthor	The author to show in the PDF file (printed on the first page).
pdfLatexPath	The path to PdfLaTex. This file is part of a LaTeX installation that creates a pdf out of a .tex file. See rnwString for more information.
rnwPath	The path where the temporary files will be stored.
filename	Filename of the PDF (".pdf" is appended).
digits	Number of digits to show.
rMatrixColsLandscape	This number determines when the page(s) in the PDF is/are rotated; pages with matrices that have this number of columns or more are rotated.
pboxWidthMultiplier	Passed on to (unexported method) print.rMatrix.
scatterPlotBaseSize	Basic size of scatterplots in centimeters. If this number, multiplied by the number of items (i.e. columns/rows in scattermatrix) is larger than maxScatterPlotSize, it is ignored.
maxScatterPlotSize	Maximum size of scatterplots; automatically calculated if NULL.
pageMargins	Margins of landscape pages in millimeters.
pval	Whether to print p-values using the p-value formatting. Passed on to (unexported method) print.rMatrix.

Details

This functon generates a PDF file from a scaleDiagnosis object. scaleDiagnosis generates an object with several useful statistics and a plot to assess how the elements (usually items) in a scale relate to each other, such as Cronbach's Alpha, omega, the Greatest Lower Bound, a factor analysis, and a correlation matrix.

Value

Nothing is returned; the file is printed to disk.

Author(s)

Gjalt-Jorn Peters

Maintainer: Gjalt-Jorn Peters <[e-mail]>

Examples

## Not run: 

### Generate a datafile to use
exampleData <- data.frame(item1=rnorm(100));
exampleData$item2 <- exampleData$item1+rnorm(100);
exampleData$item3 <- exampleData$item1+rnorm(100);
exampleData$item4 <- exampleData$item2+rnorm(100);
exampleData$item5 <- exampleData$item2+rnorm(100);

### Use all items and create object
scaleDiagnosisObject <- scaleDiagnosis(dat=exampleData);

### Generate a PDF
scaleDiagnosisToPDF(scaleDiagnosisObject);


## End(Not run)

userfriendlyscience documentation built on May 2, 2019, 1:09 p.m.