setPlotParms: Sets the default plotting parameters for RSCABS

Description Usage Arguments Value Note Author(s) See Also

View source: R/setPlotParms.r

Description

An internal function for setting the plotting parameters not defined by the prior to function call. This is called by plotRSCABS.

Usage

1
setPlotParms(PlotParms, Out, Effect, Metric, Lowest,...)

Arguments

PlotParms

A list that contains values for the plotting parameters for barplot.

Out

A matrix of values that will be plotted.

Effect

The name of the endpoint being plotted.

Metric

The value being plotted and be "Total" or "Percent".

Lowest

Determines whether to "Include" or "Remove" the lowest response. The lowest response should correspond to no effect.

...

Other arguments to be passed to barplot.

Value

The values of PlotParms have the same name as the plotting parameters of barplot.

xlab

The label for the x axis, defaults to 'Treatment Group'.

ylab

The label for the y axis, defaults to the value of Metric.

main

The title.

legend.text

The legend text defaults to name of the rows of Out.

args.legend

Extra parameters to be passed to legend. Defaults to placing the legend in the right margin.

ColorFunction

The code pallet used to color the bar plots. Defaults to using heat.colors.

Colors

The colors used in the bar plot. Defaults to using the pallet determined by ColorFunction.

Note

This function only changes item in PlotParms that have a NULL value.

Author(s)

Joe Swintek

See Also

plotRSCABS


RSCABS documentation built on May 1, 2020, 9:06 a.m.