par                 package:graphics                 R Documentation

_S_e_t _o_r _Q_u_e_r_y _G_r_a_p_h_i_c_a_l _P_a_r_a_m_e_t_e_r_s

_D_e_s_c_r_i_p_t_i_o_n:

     'par' can be used to set or query graphical parameters. Parameters
     can be set by specifying them as arguments to 'par' in 'tag =
     value' form, or by passing them as a list of tagged values.

_U_s_a_g_e:

     par(..., no.readonly = FALSE)

     <highlevel plot> (..., <tag> = <value>)

_A_r_g_u_m_e_n_t_s:

     ...: arguments in 'tag = value' form, or a list of tagged values. 
          The tags must come from the graphical parameters described
          below.

no.readonly: logical; if 'TRUE' and there are no other arguments, only
          parameters are returned which can be set by a subsequent
          'par()' call.

_D_e_t_a_i_l_s:

     Parameters are queried by giving one or more character vectors to
     'par'.

     'par()' (no arguments) or 'par(no.readonly=TRUE)' is used to get
     _all_ the graphical parameters (as a named list).  Their names are
     currently taken from the unexported variable '.Pars'.

     _*R.O.*_ indicates _*read-only arguments*_: These may only be used
     in queries and cannot be set.  ('"cin"', '"cra"', '"csi"', '"cxy"'
     and '"din"' are always read-only, and '"gamma"' is on most
     devices.)

     There are several parameters can only be set by a call to 'par()':

        *  '"ask"'

        *  '"family"', '"fig"', '"fin"'

        *  '"lend"', '"lheight"', '"ljoin"', '"lmitre"'

        *  '"mai"', '"mar"', '"mex"', '"mfcol"', '"mfrow"', '"mfg"'

        *  '"new"'

        *  '"oma"', '"omd"', '"omi"'

        *  '"pin"', '"plt"', '"ps"', '"pty"'

        *  '"usr"'

        *  '"xlog"', '"ylog"'

     The remaining parameters can also be set as arguments (often via
     '...') to high-level plot functions such as 'plot.default',
     'plot.window', 'points', 'lines', 'abline', 'axis', 'title',
     'text', 'mtext', 'segments', 'symbols', 'arrows', 'polygon',
     'rect', 'box', 'contour', 'filled.contour' and 'image'.  Such
     settings will be active during the execution of the function,
     only.  However, see the comments on 'bg' and 'cex', which may be
     taken as arguments to certain plot functions rather than as
     graphical parameters.

_V_a_l_u_e:

     When parameters are set, their former values are returned in an
     invisible named list.  Such a list can be passed as an argument to
     'par' to restore the parameter values. Use 'par(no.readonly =
     TRUE)' for the full list of parameters that can be restored.

     When just one parameter is queried, the value of that parameter is
     returned as (atomic) vector.  When two or more parameters are
     queried, their values are returned in a list, with the list names
     giving the parameters.

     Note the inconsistency: setting one parameter returns a list, but
     querying one parameter returns a vector.

_G_r_a_p_h_i_c_a_l _P_a_r_a_m_e_t_e_r_s:

     '_a_d_j' The value of 'adj' determines the way in which text strings
          are justified.  A value of '0' produces left-justified text,
          '0.5' centered text and '1' right-justified text.  (Any value
          in [0, 1] is allowed, and on most devices values outside that
          interval will also work.) Note that the 'adj' argument of
          'text' also allows 'adj = c(x, y)' for different adjustment
          in x- and y- direction.

     '_a_n_n' If set to 'FALSE', high-level plotting functions calling
          'plot.default' do not annotate the plots they produce with
          axis titles and overall titles.  The default is to do
          annotation.

     '_a_s_k' logical.  If 'TRUE', the user is asked for input, before a
          new figure is drawn.

     '_b_g' The color to be used for the background of plots. A
          description of how colors are specified is given below. Note
          that some graphics functions such as 'plot.default' and
          'points' have an _argument_ of this name with a different
          meaning.

     '_b_t_y' A character string which determined the type of 'box' which
          is drawn about plots.  If 'bty' is one of '"o"', '"l"',
          '"7"', '"c"', '"u"', or '"]"' the resulting box resembles the
          corresponding upper case letter.  A value of '"n"' suppresses
          the box.

     '_c_e_x' A numerical value giving the amount by which plotting text
          and symbols should be scaled relative to the default.  Note
          that some graphics functions such as 'plot.default' have an
          _argument_ of this name which multiplies this graphical
          parameter.

     '_c_e_x._a_x_i_s' The magnification to be used for axis annotation
          relative to the current setting of 'cex'.

     '_c_e_x._l_a_b' The magnification to be used for x and y labels relative
          to the current setting of 'cex'.

     '_c_e_x._m_a_i_n' The magnification to be used for main titles relative
          to the current setting of 'cex'.

     '_c_e_x._s_u_b' The magnification to be used for sub-titles relative to
          the current setting of 'cex'.

     '_c_i_n' _*R.O.*_; character size '(width,height)' in inches.

     '_c_o_l' A specification for the default plotting color.  A
          description of how colors are specified is given below.

     '_c_o_l._a_x_i_s' The color to be used for axis annotation.

     '_c_o_l._l_a_b' The color to be used for x and y labels.

     '_c_o_l._m_a_i_n' The color to be used for plot main titles.

     '_c_o_l._s_u_b' The color to be used for plot sub-titles.

     '_c_r_a' _*R.O.*_; size of default character '(width,height)' in
          "rasters" (pixels).

     '_c_r_t' A numerical value specifying (in degrees) how single
          characters should be rotated.  It is unwise to expect values
          other than multiples of 90 to work.  Compare with 'srt' which
          does string rotation.

     '_c_s_i' _*R.O.*_; height of (default sized) characters in inches.

     '_c_x_y' _*R.O.*_; size of default character '(width,height)' in user
          coordinate units. 'par("cxy")' is 'par("cin")/par("pin")'
          scaled to user coordinates. Note that 'c(strwidth(ch),
          strheight(ch))' for a given string 'ch' is usually much more
          precise.

     '_d_i_n' _*R.O.*_; the device dimensions, '(width,height)', in
          inches.

     '_e_r_r' (_Unimplemented_; R is silent when points outside the plot
          region are _not_ plotted.) The degree of error reporting
          desired.

     '_f_a_m_i_l_y' The name of a font family for drawing text. The maximum
          allowed length is 49 bytes. This name gets mapped by each
          graphics device to device-specific font descriptions. The
          default value is '""' which means that the default device
          fonts will be used. Standard values are '"serif"', '"sans"',
          '"mono"', and '"symbol"' and the Hershey font families are
          also available.  Different devices may define others.  Some
          devices will ignore this setting completely.

     '_f_g' The color to be used for the foreground of plots. This is the
          default color used for things like axes and boxes around
          plots.  When called from 'par()' this also sets parameter
          'col' to the same value.

          A description of how colors are specified is given below.

     '_f_i_g' A numerical vector of the form 'c(x1, x2, y1, y2)' which
          gives the (NDC) coordinates of the figure region in the
          display region of the device. If you set this, unlike S, you
          start a new plot, so to add to an existing plot use
          'new=TRUE' as well.

     '_f_i_n' The figure region dimensions, '(width,height)', in inches.
          If you set this, unlike S, you start a new plot.

     '_f_o_n_t' An integer which specifies which font to use for text.  If
          possible, device drivers arrange so that 1 corresponds to
          plain text, 2 to bold face, 3 to italic and 4 to bold italic.
           Also, font 5 is expected to be the symbol font, in Adobe
          symbol encoding.  On some devices font families can be
          selected by 'family' to choose different sets of 5 fonts.

     '_f_o_n_t._a_x_i_s' The font to be used for axis annotation.

     '_f_o_n_t._l_a_b' The font to be used for x and y labels.

     '_f_o_n_t._m_a_i_n' The font to be used for plot main titles.

     '_f_o_n_t._s_u_b' The font to be used for plot sub-titles.

     '_g_a_m_m_a' the gamma correction, see argument 'gamma' to 'hsv'.  This
          is only accepted if the current device has support for
          changing the gamma correction: currently only 'windows' and
          'quartz' do.  ('X11' has support for setting the gamma
          correction when opening the device, but not for changing it.)

     '_l_a_b' A numerical vector of the form 'c(x, y, len)' which modifies
          the default way that axes are annotated.  The values of 'x'
          and 'y' give the (approximate) number of tickmarks on the x
          and y axes and 'len' specifies the label length.  The default
          is 'c(5, 5, 7)'.  Note that this only affects the way the
          parameters 'xaxp' and 'yaxp' are set when the user coordinate
          system is set up, and is not consulted when axes are drawn.
          'len' _is unimplemented_ in R.

     '_l_a_s' numeric in {0,1,2,3}; the style of axis labels.

          _0: always parallel to the axis [_default_],

          _1: always horizontal,

          _2: always perpendicular to the axis,

          _3: always vertical.

          Note that other string/character rotation (via argument 'srt'
          to 'par') does _not_ affect the axis labels.

     '_l_e_n_d' The line end style. This can be specified as an integer or
          string: 0 and '"round"' mean rounded line caps; 1 and
          '"butt"' mean butt line caps; 2 and '"square"' mean square
          line caps.

     '_l_h_e_i_g_h_t' The line height multiplier. The height of a line of text
          (used to vertically space multi-line text) is found by
          multiplying the current font size both by the current
          character expansion and by the line height multiplier. 
          Default value is 1.

     '_l_j_o_i_n' The line join style. This can be specified as an integer
          or string: 0 and '"round"' mean rounded line joins; 1 and
          '"mitre"' mean mitred line joins; 2 and '"bevel"' mean
          bevelled line joins.

     '_l_m_i_t_r_e' The line mitre limit. This controls when mitred line
          joins are automatically converted into bevelled line joins. 
          The value must be larger than 1 and the default is 10.  Not
          all devices will honour this setting.

     '_l_t_y' The line type. Line types can either be specified as an
          integer (0=blank, 1=solid, 2=dashed, 3=dotted, 4=dotdash,
          5=longdash, 6=twodash) or as one of the character strings
          '"blank"', '"solid"', '"dashed"', '"dotted"', '"dotdash"',
          '"longdash"', or '"twodash"', where '"blank"' uses 'invisible
          lines' (i.e., doesn't draw them).

          Alternatively, a string of up to 8 characters (from 'c(1:9,
          "A":"F")') may be given, giving the length of line segments
          which are alternatively drawn and skipped.  See section 'Line
          Type Specification' below.

     '_l_w_d' The line width, a _positive_ number, defaulting to '1'.  The
          interpretation is device-specific, and some devices do not
          implement line widths less than one.

     '_m_a_i' A numerical vector of the form 'c(bottom, left, top, right)'
          which gives the margin size specified in inches.

     '_m_a_r' A numerical vector of the form 'c(bottom, left, top, right)'
          which gives the number of lines of margin to be specified on
          the four sides of the plot. The default is 'c(5, 4, 4, 2) +
          0.1'.

     '_m_e_x' 'mex' is a character size expansion factor which is used to
          describe coordinates in the margins of plots. Note that this
          does not change the font size, rather specifies the size of
          font used to convert between 'mar' and 'mai', and between
          'oma' and 'omi'.

     '_m_f_c_o_l, _m_f_r_o_w' A vector of the form 'c(nr, nc)'. Subsequent
          figures will be drawn in an 'nr'-by-'nc' array on the device
          by _columns_ ('mfcol'), or _rows_ ('mfrow'), respectively.

          In a layout with exactly two rows and columns the base value
          of '"cex"' is reduced by a factor of 0.83: if there are three
          or more of either rows or columns, the reduction factor is
          0.66.

          Consider the alternatives, 'layout' and 'split.screen'.

     '_m_f_g' A numerical vector of the form 'c(i, j)' where 'i' and 'j'
          indicate which figure in an array of figures is to be drawn
          next (if setting) or is being drawn (if enquiring).  The
          array must already have been set by 'mfcol' or 'mfrow'.

          For compatibility with S, the form 'c(i, j, nr, nc)' is also
          accepted, when 'nr' and 'nc' should be the current number of
          rows and number of columns.  Mismatches will be ignored, with
          a warning.

     '_m_g_p' The margin line (in 'mex' units) for the axis title, axis
          labels and axis line. The default is 'c(3, 1, 0)'.

     '_m_k_h' The height in inches of symbols to be drawn when the value
          of 'pch' is an integer. _Completely ignored currently_.

     '_n_e_w' logical, defaulting to 'FALSE'.  If set to 'TRUE', the next
          high-level plotting command (actually 'plot.new') should _not
          clean_ the frame before drawing "as if it was on a *_new_*
          device".

     '_o_m_a' A vector of the form 'c(bottom, left, top, right)' giving
          the size of the outer margins in lines of text.

     '_o_m_d' A vector of the form 'c(x1, x2, y1, y2)' giving the outer
          margin region in NDC (= normalized device coordinates), i.e.,
          as fraction (in [0,1]) of the device region.

     '_o_m_i' A vector of the form 'c(bottom, left, top, right)' giving
          the size of the outer margins in inches.

     '_p_c_h' Either an integer specifying a symbol or a single character
          to be used as the default in plotting points.  See 'points'
          for possible values and their interpretation.

     '_p_i_n' The current plot dimensions, '(width,height)', in inches.

     '_p_l_t' A vector of the form 'c(x1, x2, y1, y2)' giving the
          coordinates of the plot region as fractions of the current
          figure region.

     '_p_s' integer; the pointsize of text (but not symbols).  Unlike the
          'pointsize' argument of most devices, this does not change
          the relationship between 'mar' and 'mai' (nor 'oma' and
          'omi'), but it does scale 'cin' and 'csi'.

          What is meant by 'pointsize' is device-specific, but most
          devices mean a multiple of 1bp, that is 1/72 of an inch.

     '_p_t_y' A character specifying the type of plot region to be used;
          '"s"' generates a square plotting region and '"m"' generates
          the maximal plotting region.

     '_s_m_o' (_Unimplemented_) a value which indicates how smooth circles
          and circular arcs should be.

     '_s_r_t' The string rotation in degrees.  See the comment about
          'crt'.

     '_t_c_k' The length of tick marks as a fraction of the smaller of the
          width or height of the plotting region. If 'tck >= 0.5' it is
          interpreted as a fraction of the relevant side, so if 'tck =
          1' grid lines are drawn.  The default setting ('tck = NA') is
          to use 'tcl = -0.5' (see below).

     '_t_c_l' The length of tick marks as a fraction of the height of a
          line of text.  The default value is '-0.5'; setting 'tcl =
          NA' sets 'tck = -0.01' which is S' default.

     '_t_m_a_g' A number specifying the enlargement of text of the main
          title relative to the other annotating text of the plot.
          Defaults to '1.2'.

     '_t_y_p_e' *Deprecated:* will be removed in R 2.3.0. character;  the
          default plot type desired, see 'plot.default(type=...)',
          defaulting to '"p"'. *NB:* This is currently used - the
          default for 'plot.default' does not depend on this par.

     '_u_s_r' A vector of the form 'c(x1, x2, y1, y2)' giving the extremes
          of the user coordinates of the plotting region.  When a
          logarithmic scale is in use (i.e., 'par("xlog")' is true, see
          below), then the x-limits will be '10 ^ par("usr")[1:2]'. 
          Similarly for the y-axis.

     '_x_a_x_p' A vector of the form 'c(x1, x2, n)' giving the coordinates
          of the extreme tick marks and the number of intervals between
          tick-marks when 'par("xlog")' is false. Otherwise, when _log_
          coordinates are active, the three values have a different
          meaning: For a small range, 'n' is _negative_, and the ticks
          are as in the linear case, otherwise, 'n' is in '1:3',
          specifying a case number, and 'x1' and 'x2' are the lowest
          and highest power of 10 inside the user coordinates, '10 ^
          par("usr")[1:2]'. (The '"usr"' coordinates are
          log10-transformed here!)

          _n=_1 will produce tick marks at 10^j for integer j,

          _n=_2 gives marks  k 10^j with k in {1, 5},

          _n=_3 gives marks  k 10^j with k in {1, 2, 5}.

          See 'axTicks()' for a pure R implementation of this.

          This parameter is reset when a user coordinate system is set
          up, for example by starting a new page or by calling
          'plot.window' or setting 'par("usr")': 'n' is taken from
          'par("lab")'.  It affects the default behaviour of subsequent
          calls to 'axis' for sides 1 or 3.

     '_x_a_x_s' The style of axis interval calculation to be used for the
          x-axis.  Possible values are '"r"', '"i"', '"e"', '"s"',
          '"d"'.  The styles are generally controlled by the range of
          data or 'xlim', if given. Style '"r"' (regular) first extends
          the data range by 4 percent and then finds an axis with
          pretty labels that fits within the range. Style '"i"'
          (internal) just finds an axis with pretty labels that fits
          within the original data range. Style '"s"' (standard) finds
          an axis with pretty labels within which the original data
          range fits. Style '"e"' (extended) is like style '"s"',
          except that it is also ensures that there is room for
          plotting symbols within the bounding box. Style '"d"'
          (direct) specifies that the current axis should be used on
          subsequent plots. (_Only '"r"' and '"i"' styles are currently
          implemented_)

     '_x_a_x_t' A character which specifies the x axis type. Specifying
          '"n"' suppresses plotting of the axis.  The standard value is
          '"s"': for compatibility with S values '"l"' and '"t"' are
          accepted but are equivalent to '"s"': any value other than
          '"n"' implies plotting.

     '_x_l_o_g' A logical value (see 'log' in 'plot.default').  If 'TRUE',
          a logarithmic scale is in use (e.g., after 'plot(*, log =
          "x")'). For a new device, it defaults to 'FALSE', i.e.,
          linear scale.

     '_x_p_d' A logical value or 'NA'. If 'FALSE', all plotting is clipped
          to the plot region, if 'TRUE', all plotting is clipped to the
          figure region, and if 'NA', all plotting is clipped to the
          device region.

     '_y_a_x_p' A vector of the form 'c(y1, y2, n)' giving the coordinates
          of the extreme tick marks and the number of intervals between
          tick-marks unless for log coordinates, see 'xaxp' above.

     '_y_a_x_s' The style of axis interval calculation to be used for the
          y-axis.  See 'xaxs' above.

     '_y_a_x_t' A character which specifies the y axis type. Specifying
          '"n"' suppresses plotting.

     '_y_l_o_g' A logical value; see 'xlog' above.

_C_o_l_o_r _S_p_e_c_i_f_i_c_a_t_i_o_n:

     Colors can be specified in several different ways. The simplest
     way is with a character string giving the color name (e.g.,
     '"red"').  A list of the possible colors can be obtained with the
     function 'colors'. Alternatively, colors can be specified directly
     in terms of their RGB components with a string of the form
     '"#RRGGBB"' where each of the pairs 'RR', 'GG', 'BB' consist of
     two hexadecimal digits giving a value in the range '00' to 'FF'.
     Colors can also be specified by giving an index into a small table
     of colors, the 'palette'.  This provides compatibility with S. 
     Index '0' corresponds to the background color.

     Additionally, '"transparent"' or (integer) 'NA' is _transparent_,
     useful for filled areas (such as the background!), and just
     invisible for things like lines or text.

     The functions 'rgb', 'hsv', 'hcl', 'gray' and 'rainbow' provide
     additional ways of generating colors.

_L_i_n_e _T_y_p_e _S_p_e_c_i_f_i_c_a_t_i_o_n:

     Line types can either be specified by giving an index into a small
     built-in table of line types (1 = solid, 2 = dashed, etc, see
     'lty' above) or directly as the lengths of on/off stretches of
     line.  This is done with a string of an even number (up to eight)
     of characters, namely non-zero (hexadecimal) digits which give the
     lengths in consecutive positions in the string.  For example, the
     string '"33"' specifies three units on followed by three off and
     '"3313"' specifies three units on followed by three off followed
     by one on and finally three off. The 'units' here are (on most
     devices) proportional to 'lwd', and with 'lwd = 1' are in pixels
     or points.

     The five standard dash-dot line types ('lty = 2:6') correspond to
     'c("44", "13", "1343", "73", "2262")'.

     Note that 'NA' is not a valid value for 'lty'.

_N_o_t_e:

     The effect of restoring all the (settable) graphics parameters as
     in the examples is hard to predict if the device has been resized.
     Several of them are attempting to set the same things in different
     ways, and those last in the alphabet will win.  In particular, the
     settings of 'mai', 'mar', 'pin', 'plt' and 'pty' interact, as do
     the outer margin settings, the figure layout and figure region
     size.

_R_e_f_e_r_e_n_c_e_s:

     Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988) _The New S
     Language_. Wadsworth & Brooks/Cole.

_S_e_e _A_l_s_o:

     'plot.default' for some high-level plotting parameters; 'colors';
     'options' for other setup parameters; graphic devices 'x11',
     'postscript' and setting up device regions by 'layout' and
     'split.screen'.

_E_x_a_m_p_l_e_s:

     op <- par(mfrow = c(2, 2), # 2 x 2 pictures on one plot
               pty = "s")       # square plotting region,
                                # independent of device size

     ## At end of plotting, reset to previous settings:
     par(op)

     ## Alternatively,
     op <- par(no.readonly = TRUE) # the whole list of settable par's.
     ## do lots of plotting and par(.) calls, then reset:
     par(op)

     par("ylog") # FALSE
     plot(1 : 12, log = "y")
     par("ylog") # TRUE

     plot(1:2, xaxs = "i") # 'inner axis' w/o extra space
     par(c("usr", "xaxp"))

     ( nr.prof <-
       c(prof.pilots=16,lawyers=11,farmers=10,salesmen=9,physicians=9,
         mechanics=6,policemen=6,managers=6,engineers=5,teachers=4,
         housewives=3,students=3,armed.forces=1))
     par(las = 3)
     barplot(rbind(nr.prof)) # R 0.63.2: shows alignment problem
     par(las = 0)# reset to default

     ## 'fg' use:
     plot(1:12, type = "b", main="'fg' : axes, ticks and box in gray",
          fg = gray(0.7), bty="7" , sub=R.version.string)

     ex <- function() {
        old.par <- par(no.readonly = TRUE) # all par settings which
                                           # could be changed.
        on.exit(par(old.par))
        ## ...
        ## ... do lots of par() settings and plots
        ## ...
        invisible() #-- now,  par(old.par)  will be executed
     }
     ex()

