21_global_options: Global Options
In barsurf: Contour Plots, 3D Plots, Vector Fields and Heatmaps

Description Usage Arguments Details Note References Examples

Set/get global options.

set.bs.options (...,
    nhl=1, ref.arrows=TRUE,
    rendering.style="R", theme="blue",
    top.color, side.color, sgrid.color, iso.colors,
    main, hcv, glass="glass.rainbow.fit", flow, lum,
    test.mode=FALSE)

set.bs.nhl (nhl)
set.bs.theme (theme)

opt.nhl ()
opt.ref.arrows ()

`nhl`	Integer, the number of header (main title) lines, in 3d plots.
`ref.arrows`	Logical vector of length one or two, if true plot reference arrows.
`rendering.style`	Single string, either "R" or "pdf", refer to details.
`theme`	String, either "gold", "blue", "green", "purple" or "heat".
`top.color, side.color`	Strings (R colors), the bar colors.
`sgrid.color`	String (R color), the surface grid color.
`iso.colors`	Character vector (R colors), the initial isosurface colors.
`main`	String, name of the main litmus-fitting function, which is the default for heatmaps, with hcv=FALSE.
`hcv`	Sting, name of the hcv (high color variation) litmus-fitting function, which is the default for heatmaps, with hcv=TRUE.
`glass`	String, name of the glass litmus-fitting function, which is the default for plot_cfield3.
`flow`	String, name of the flow litmus-fitting function, which is the default for vector fields.
`lum`	String, name of the lum litmus-fitting function, which is the default for surface plots.
`test.mode`	If true, and the main plotting functions are called with unmatched arguments, then an error is generated. This should be false, except for testing purposes.
`...`	Ignored.

The set functions, set global options, and the opt functions gets them.

The "R" rendering style is for standard R graphic devices, and raster images.
The "pdf" rendering style is for PDF documents and other scalable vector formats.

The "pdf" option is the same as the "R" option, except that vector arrow lines, grid lines and wire frame lines are narrower.
However, the end result is dependent on the PDF viewer.

The blue and green themes are designed for relatively high perceptual uniformity.
And the heat theme is designed for high impact.

Calling the set.bs.options function will set all the options.
The default values of most color-based arguments are dependent on the theme.

In contrast, calling the set.bs.nhl functions will only change the nhl option, and calling the set.bs.theme function, will only change color-related options.

Do not change global options, directly.

But rather, use set.bs.options, set.nhl or set.theme functions.

Refer to the vignette for an overview, references and better examples.