didacticPlot: didacticPlot

Description Usage Arguments Value Examples

View source: R/didacticPlot.R

Description

didacticPlot is useful for making ggplot2 plots of distributions of t, F, Chi^2, and Pearson r, showing a given value, and shading the arie covering the more extreme values. didacticPlotTheme is the basic theme.

Usage

1
2
3
4
5
6
didacticPlot(foundValue, statistic, df1, df2 = NULL,
             granularity = 1000, xLim = NULL, yLab = NULL,
             lineCol = "red", lineSize=1,
             surfaceCol = "red", textMarginFactor = 20,
             sided="two")
didacticPlotTheme(base_size = 14, base_family = "")

Arguments

foundValue

The value to indicate (the 'found' value).

statistic

One of "r", "t", "f" or "chisq".

df1, df2

The degrees of freedom; only use df1 for the r, t and chi^2 test; for the F-test, use df1 for the degrees of freedom of the denominator and df2 for the degrees of freedom of the numerator.

granularity

Steps to use for x-axis.

xLim

Vector; minimum and maximum values on x axis.

yLab

Label on y axis.

lineCol

Colour of density line.

lineSize

Size of density line.

surfaceCol

Colour of coloured surface area.

textMarginFactor

Used to calculate how close to the vertical line text labels should appear.

sided

Whether to make a plot for a 2-sided or 1-sided test.

base_size, base_family

Passed on to the grey ggplot theme.

Value

didacticPlot returns an object that contains the plot in the $plot element.

Examples

1
2
3
4
5
6
7
8
9
didacticPlot(1, statistic='chisq', df1=2);

didacticPlot(1, statistic='t', df1=40);

didacticPlot(2.02, statistic='t', df1=40, textMarginFactor=25);

### Two sample t-test for n1 = n2 = 250, showing
### p-value of 5%
# a<-didacticPlot(1.96, statistic='t', df1=498);

userfriendlyscience documentation built on May 2, 2018, 5:06 p.m.