nhstplot
is a fairly
simple package to use. This vignette is intended to explain the basics
(plotting using the defaults), before showing how to use the
options.
After installing the library with
install.packages("nhstplot")
you need to load the
library:
nhstplot
is composed of 4 functions, one for each major
NHST test “family” :
plotchisqtest
function)plotftest
function)plotttest
function)plotztest
function)Let’s see how to use each one without changing the graphical options.
The plotchisqtest
function only requires 2 arguments :
The first one is the χ2 value (parameter :
chisq
), and the second one is the degrees of freedom
(parameter df
).
Here’s an example with respectively 8 and 4.
Note that the same is achieved with
plotchisqtest(8,4)
.
You can also use the function by passing an object created by
chisq.test()
…
…or a model comparison from the anova()
function.
The plotftest
function only requires 3 arguments : The
first one is the F value
(parameter : f
), and the second and third ones are
respectively the degrees of freedom of the numerator (parameter
dfnum
) and the denominator (parameter
dfdenom
).
Here’s an example with respectively 4, 3 and 5.
Note that the same is achieved with
plotftest(4,3,5)
.
You can also use the function by passing an object created by
lm()
…
…or by passing an F-change test computed with the
anova()
function:
The plotttest
function only requires 2 arguments : The
first one is the t value
(parameter : t
), and the second one is the degrees of
freedom of the numerator (argument df
).
Here’s an example with respectively 2 and 10.
Note that the same is achieved with plotttest(2,10)
.
By default, the plotttest
function plots a two-tailed
test. However, a one-tailed test can be plotted by adding the argument
tails = "one"
:
The left or right tail is automatically selected using the sign of provided t:
You can also use the function by passing an object created by
t.test()
…
…or cor.test()
.
The plotztest
function only requires 1 argument : The
z value (parameter
z
).
Here’s an example with a z value of 2.
Note that the same is achieved with plozttest(2)
.
By default, the plotztest
function plots a two-tailed
test. However, a one-tailed test can be plotted by adding the argument
tails = "one"
:
The left or right tail is automatically selected using the sign of provided t:
NHST is a process that isn’t straightforward to explain or understand. Before looking at the p value itself, it starts with stating a null hypothesis. As a consequence, it can be helpful to provide a “step-by-step” explanation of process that may require to plot the density probability function before adding the cutline and p-value.
Hopefully, all the functions in nhstplot
can do that
very simply by passing the argument blank = TRUE
.
In reality, when blank = TRUE
, every thing is plotted
the same way as with blank = FALSE
(default), but some
objects are simply make transparent. This means that the two plots are
scaled exactly the same way, which can be useful to plot one version
after another, for example in slides of a presentation or in an animated
gif.
The argument xmax
can be used to manually provide a
maximum for the x-axis. For symmetrical distributions (t and z), the minimum is set
automatically, so only one value (the maximum) should be provided.
For all 4 functions, the default theme is light blue and red (like
seen above). But other themes are available with the
theme
parameter, as shown below.
A first important note : The theme
argument supersedes
any custom colors you may use, so don’t provide anything (or
default
) to the theme
parameter if you want to
use custom colors.
colorleft
, colorleftcurve
,
colorright
and colorrightcurve
control the
curve and areas under the curve colors in the plotchisqtest
and plotftest
functions. Additionnally,
colorplabel
and colorcutline
control the
colors of the p value label and of the cut line. For example:plotftest(4, 3, 5, colorleft = "lightgreen", colorleftcurve = "red", colorright = "indianred", colorrightcurve = "blue", colorplabel = "darkgrey", colorcut = "#FFA500")
colormiddle
, colormiddlecurve
,
colorsides
and colorsidescurve
control the
curve and areas under the curve colors in the plotttest
and
plotztest
functions. Additionnally,
colorplabel
(defaults to the same and
colorcutline
control the colors of the p value label and of
the cut line. For example:The font family of all the text in the graph can be changed using the
fontfamily
argument (you can for example use
mono
, Palatino
, Helvetica
or
sans
. The default is serif
.
extrafonts
can be used to provide
your own fonts (e.g. to match your slides font), and appears to work
well with nhstplot
. Fonts loaded through
extrafonts
can be called in the fontfamily
argument in the nhstplot
functions (e.g.,
plotztest(2, fontfamily = "Roboto")
).The cutlinesize
and the curvelinesize
control the size of the line sizes. By default, the
cutlinesize
is the same as the
curvelinesize
.
The number of significant digits can be modified in all functions
using signifdigitschisq
/ signifdigitsf
/
signifdigitst
/ signifdigitsz
for the test
statistic. The default is 3
for all.
The position of the p value
can be changed using the p_value_position
argument and
providing a vector of coordinates. The absolute value is used and the
sign is changed depending on whether a one-tailed test is plotted or not
(and which tail it is).