R: Auxilary for Controlling the General Appearance of a Rose...

general.control {IDPmisc} | R Documentation

## Auxilary for Controlling the General Appearance of a Rose Plot

### Description

Defines the General Appearance of rose plot.

### Usage

    general.control(stacked = FALSE,
                    rose.rad = NULL, rose.x = NULL, rose.y = NULL,
                    mar = rep(0.3, 4),
                    rev.col = FALSE,
                    shift = 0,
                    cex = 1, col = NULL, lty = 1:3, lwd = 1, type = "s")

### Arguments

`stacked` | `stacked = FALSE`: For each point `(x@rho[i,j], x@cyclVar[i])` with `x` equal to a `rose` object, the radius is `x@rho[i,j]` - `ray.lim[1]` as defined in `grid.control`. Points with identical `j` are connected by a colored line. `stacked = TRUE`: For each point `(x@rho[i,j], x@cyclVar[i])`, the radius is `sum(x@rho[1:i,j])`. No negative values are allowed in the stacked case as this feature makes sense only for variables like proportions, counts or concentrations. Areas between two adjacent `j` are filled by color. `NA` values in `x@rho` are interpreted as `0` and a warning is issued.
`rose.rad, rose.x, rose.y` | Approximate length of radius, x- and y-position of rose. Default units are mm but any valid grid unit might be chosen (cf. `unit`. If one or more of these arguments are defined, the user of the plot function must make sure that the size of the viewport is large enough to show the complete rose and the legend. These arguments are especially useful when a series of plots of exactly the same size and position of the rose on the viewport has to be produced.
`mar` | Margin around the plotting area. Default units are `grid.control(cyclVar.cex)`. Other units can be defined by `unit`.
`rev.col` | `= TRUE`: Ordering of the columns of `x@rho` is reversed.
`shift` | Shifts the plot in clockwise direction by this angle. Units of `shift` must be identical with units of `cyclVar` in `link{plot.rose}`
`cex` | Basic size of characters in the plot.
`col` | Colors of lines when `stacked = FALSE` or colors of stacked areas else. In the first case colors are by default as distinct as possible; in the latter case, all colors are matched by default to the range green (=center of rose) to blue (outside of rose).
`lty, lwd` | Line type and line width. When `stacked = TRUE` and `lwd = 0` the colored aereas are drawn without black borders.
`type` | 1-character string giving the type of plot desired: "s" plots observations as segments. This option is the proper way to distplay rose data. "l" plots a line joining the data points. This option is a nicer to look at when data are smoothly distributed in all directions.

### Value

Returns the arguments conveniently packaged up in a list to supply the general arguments for `plot.rose`.

### Author(s)

Rene Locher

### See Also

`plot.rose`, `grid.control`

### Examples

    general.control()

[Package IDPmisc version 1.1.20 Index]