hist.residLen {analogue} R Documentation

## Histogram plot for residual lengths

### Description

Base graphics histogram plot method for `residLen` objects.

### Usage

```## S3 method for class 'residLen'
hist(x, breaks = "Sturges", freq = TRUE,
probs = c(0.9, 0.95, 0.99), ncol = 1, lcol = "red",
llty = "dashed", xlab = NULL, ylab = NULL,
main = "Residual distances", rug = TRUE, ...)
```

### Arguments

 `x` Object of class `"residLen"`, the result of a call to `residLen`. `breaks` How breakpoints for the histogram are determined. See `hist` for more details. `freq` logical; if `TRUE`, the histogram graphic is a representation of frequencies, the `counts` component of the result; if `FALSE`, probability densities, component `density`, are plotted (so that the histogram has a total area of one). Defaults to `TRUE` `probs` numeric; vector of probability quantiles to compute from the sets of residual distances. `ncol` numeric; number of columns for the plot layout. Choices are `1` or `2`. Determines whether the histograms are plotted above or beside each other. `lcol, llty` colour and line-type for the quantiles. `xlab, ylab` Axis labels. If not supplied, suitable defaults are generated, depending on whether RDA or CCA was used as the underlying ordination model. `main` character; title for the plot. `rug` logical; should rug plots of the actual distances be drawn? `...` additional arguments passed to `hist`.

### Value

A plot on the current device.

Returns a list with two components (`train` and `passive`), each of which is an object returned by `hist`.

### Author(s)

Gavin L. Simpson

`residLen`, `plot.residLen`, `histogram.residLen`, `densityplot.residLen`.

### Examples

```## load the Imbrie and Kipp example data
data(ImbrieKipp, SumSST, V12.122)

## squared residual lengths for Core V12.122
rlens <- residLen(ImbrieKipp, SumSST, V12.122)
rlens

## plot a histogram of the residual distances
hist(rlens)

```

[Package analogue version 0.17-6 Index]