exportPDF: Produce a summary of an object in a PDF file

Description Usage Arguments Methods (by class)

Description

This generic method intends to produce a summary of the object in a PDF file. You can also keep the tex source to reuse it in your own documents.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## S4 method for signature 'Rsocialdata'
exportPDF(object, pdfSavingName, dateformat,
  page.orientation = "landscape", latexPackages = NULL, keepTex = F,
  openPDF = T, description.chlength = 300, valids.chlength = 40,
  valids.cut.percent = 0.5, sorting = "decreasing", width.id = 0.5,
  width.varname = 1.5, width.description = 10.5, width.n = 0.8,
  width.na = 1.2, width.valids = 5, width.valids.nao.inc = 5,
  width.min = 1.25, width.max = 1.25, width.mean = 1.25,
  width.stddev = 1.25)

exportPDF(object, pdfSavingName, dateformat, page.orientation = "portrait",
  latexPackages = NULL, keepTex = F, openPDF = T, ...)

## S4 method for signature 'RegLog'
exportPDF(object, pdfSavingName, graphics = FALSE,
  page.orientation = "portrait", latexPackages = NULL, keepTex = FALSE,
  openPDF = TRUE, ...)

Arguments

object

the object for which you to write the summary in PDF.

pdfSavingName

a character

dateformat

a character

description.chlength

a numeric

graphics

a logical

keepTex

a logical keep the source of the tex file?

latexPackages

a character. You can add LaTeX packages you need for the compilation here, especially for supporting other languages than english.

page.orientation

the orientation of the page, either "portrait" or "landscape".

sorting

a character. If "decreasing" valid cases are sorted in decrease order of their frequencies. If "increase" an increasing order is used.

valids.chlength

a numeric

valids.cut.percent

a numeric. The minimal frequency need for a valid case to be reported in the document.

width.id

a numeric. Width for the variable row index column, in cm.

width.varname

a numeric. Width for variable name column, in cm.

width.description

a numeric. Width for description column, in cm.

width.n

a numeric. Width for number of valid cases column, in cm.

width.na

a numeric. Width for percents of missing values column, in cm.

width.valids

a numeric. For categorical variables, width for the valid cases listing column, in cm.

width.valids.nao.inc

a numeric. For nominal and ordinal variables, allow to increase the width of the valid cases listing column by reducing the description column, in cm.

width.min

a numeric. For quantitative variables, the with of the minimal values column, in cm.

width.max

a numeric. For quantitative variables, the with of the maximal values column, in cm.

width.mean

a numeric. For quantitative variables, the with of the means column, in cm.

width.stddev

a numeric. For quantitative variables, the with of the standard deviations column, in cm.

openPDF

a logical open the PDF after generation completed?

...

Other options to pass to the function. For Statdf objects the option merge, with argument 'no', 'left' or 'right' allow to merge or not the p-values columns, either with the next left or right column.

Methods (by class)


Rsocialdata documentation built on May 2, 2019, 4:44 p.m.