pmx_gpar: Handling pmx Graphical parameters

View source: R/gpar.R

pmx_gparR Documentation

Handling pmx Graphical parameters

Description

Handling pmx Graphical parameters

Usage

pmx_gpar(
  is.title,
  labels,
  axis.title,
  which_pages,
  print,
  axis.text,
  ranges,
  is.smooth,
  smooth,
  is.band,
  band,
  is.draft,
  draft,
  discrete,
  is.identity_line,
  identity_line,
  smooth_with_bloq,
  scale_x_log10,
  scale_y_log10,
  color.scales,
  is.legend,
  legend.position
)

Arguments

is.title

logical if TRUE then a title is used for the plot

labels

list of labels, like title, subtitle, x , y

axis.title

list or element_text (same as ggplot2 axis.title theme)

which_pages

page(s) to display; if "all" display all pages, if 1 display first page, if c(1,2) display first and second pages

print

if TRUE the ouptut will be a print not a ggplot2. This is useful for rmarkdwon output to avoid verbose list index print.

axis.text

list or element_text (same as ggplot2 axis.text theme)

ranges

limits of x/y ranges

is.smooth

logical if set to TRUE add smooth layer

smooth

smooth layer parameters

is.band

logical if TRUE add horizontal band

band

horizontal band parameters

is.draft

logical if TRUE add draft layer

draft

draft layer parameters

discrete

logical if TRUE x axis is discrete(FALSE by default)

is.identity_line

logical if TRUE add y=x line

identity_line

list y=x aes properties

smooth_with_bloq

logical if TRUE perform spline in plots with BLOQ data

scale_x_log10

logical if TRUE add scale_x_log10 layer

scale_y_log10

logical if TRUE add scale_y_log10 layer

color.scales

list define scales parameter in case of strat.color pmx_settings

is.legend

logical if TRUE x axis is discrete(FALSE by default)

legend.position

charcater legend position it takes the same value as the equivalent ggplot2 parameter

Details

This object contains all general graphic settings. It used internally by all pmx_plot(generic function) to set the default behavior.

Value

An object of class "pmx_gpar".


ggPMX documentation built on July 9, 2023, 7:45 p.m.