panderMethods: userfriendlyscience methods to pander objects

In Matherion/userfriendlyscience: Quantitative Analysis Made Accessible

Description

These methods try to provide output that's ready for R Markdown. Note that they are not all documented; most of them are quite straightforward.

Usage

## S3 method for class 'freq'
pander(x, ...)
## S3 method for class 'meanDiff'
pander(x, digits=x$digits, powerDigits=x$digits + 2, ...)
## S3 method for class 'normalityAssessment'
pander(x, headerPrefix = "#####", suppressPlot = FALSE, ...)
## S3 method for class 'dataShape'
pander(x, digits=x$input$digits, extraNotification=TRUE, ...)
## S3 method for class 'associationMatrix'
pander(x, info = x$input$info, file = x$input$file, ...)
## S3 method for class 'crossTab'
pander(x, digits = x$input$digits,
                          pValueDigits=x$input$pValueDigits, ...)
## S3 method for class 'oneway'
pander(x, digits = x$input$digits,
                        pvalueDigits=x$input$pvalueDigits,
                        headerStyle = "**",
                        na.print="", ...)
## S3 method for class 'regr'
pander(x, digits=x$input$digits,
                      pvalueDigits=x$input$pvalueDigits, ...)
## S3 method for class 'descr'
pander(x, headerPrefix = "", headerStyle = "**", ...)
## S3 method for class 'examine'
pander(x, headerPrefix = "", headerStyle = "**",
                         secondaryHeaderPrefix = "", secondaryHeaderStyle =
                         "*", ...)
## S3 method for class 'examineBy'
pander(x, headerPrefix = "", headerStyle = "**",
                           secondaryHeaderPrefix = "", secondaryHeaderStyle =
                           "*", tertairyHeaderPrefix = "--> ",
                           tertairyHeaderStyle = "", separator = paste0("\n\n",
                           repStr("-", 10), "\n\n"), ...)
## S3 method for class 'frequencies'
pander(x, prefix = "###", ...)

Arguments

x	The object to print.
digits	The number of significant digits to print.
powerDigits	Number of digits to use when printing the power.
headerPrefix, secondaryHeaderPrefix, tertairyHeaderPrefix, prefix	Prefix for headers, can be used to output headers for pandoc using R Markdown by specifying e.g. '####' for a level 4 header.
headerStyle, secondaryHeaderStyle, tertairyHeaderStyle	A character value to pre- and append to the header. This can be used to make the header appear bold ('**') or italic ('*') when not using an actual header (see headerPrefix).
separator	Separator to show between sections of output.
suppressPlot	Whether to suppress printing plots.
pValueDigits	Output to produce; see /code/linkrMatrix for details.
info, file	Output to produce and file to write to; see /code/linkassociationMatrix for details.
extraNotification	Whether an extra notification about the type of skewness and kurtosis returned by dataShape is shown.
pvalueDigits	The number of digits to show for p-values; smaller p-values will be shown as <.001 or <.0001 etc.
na.print	What to print for missing values, for example for a oneway anova table.
...	Additional arguments that are passed on to the print functions when it is called.

Value

These printing methods use cat, cat0, and grid.draw to print stuff.

Author(s)

Gjalt-Jorn Peters

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

Examples

userfriendlyscience:::pander.oneway(oneway(y=ChickWeight$weight, x=ChickWeight$Diet));

Matherion/userfriendlyscience documentation built on May 7, 2019, 3:41 p.m.