cenboxplot: Produces a censored boxplot

Description Usage Arguments Value Author(s) References Examples

View source: R/summary.R

Description

Draws a boxplot with the highest censoring threshold shown as a horizontal line. Any statistics below this line are invalid are must be estimated using methods for censored data.

Usage

1
    cenboxplot(obs, cen, group, log=TRUE, range=0, ...)

Arguments

obs

A numeric vector of observations.

cen

A logical vector indicating TRUE where an observation in x is censored (a less-than value) and FALSE otherwise.

group

A factor vector used for grouping ‘obs’ into subsets (each group will be a separate box).

log

A TRUE/FALSE indicating if the y axis should be in log units. Default it TRUE.

range

This determines how far the plot whiskers extend out from the box. If 'range' is positive, the whiskers extend to the most extreme data point which is no more than 'range' times the interquartile range from the box. The default is zero which causes the whiskers to extend to the min and max data values.

...

Additional items that get passed to boxplot.

Value

Returns the output of the default boxplot method.

Author(s)

R. Lopaka Lee <rclee@usgs.gov>

Dennis Helsel <dhelsel@practicalstats.com>

References

Helsel, Dennis R. (2005). Nondectects and Data Analysis; Statistics for censored environmental data. John Wiley and Sons, USA, NJ.

Examples

1
2
    data(Golden)
    with(Golden, cenboxplot(Blood, BloodCen, DosageGroup))

Example output

Loading required package: survival

Attaching package: 'NADA'

The following object is masked from 'package:stats':

    cor

NADA documentation built on March 22, 2020, 5:07 p.m.

Related to cenboxplot in NADA...