flowViz.par.get           package:flowViz           R Documentation

_Q_u_e_r_y _a_n_d _s_e_t _s_e_s_s_i_o_n-_w_i_d_e _g_r_a_p_h_i_c_a_l _p_a_r_a_m_e_t_e_r _d_e_f_a_u_l_t_s.

_D_e_s_c_r_i_p_t_i_o_n:

     'flowViz.par.get' is the equivalent to 'trellis.par.get'. It
     queries the session wide defaults for all 'lattice' and 'flowViz'
     graphical parameters.

     'flowViz.par.set' is the equivalent to 'trellis.par.set'. It sets
     the same set of graphical parameters, either in the 'flowViz'
     package or directly in 'lattice'.

_U_s_a_g_e:

     flowViz.par.get(name = NULL)

     flowViz.par.set(name, value, ..., theme, warn = TRUE, strict = FALSE)

_A_r_g_u_m_e_n_t_s:

    name: The name of a parameter category to set. 

   value: A named list of values to set for category 'name' or a list
          of such lists if 'name' is missing.  

     ...: Further arguments that get passed on. 

   theme: The theme to set. See 'trellis.par.set' for details. 

    warn: This gets passed on directly to 'trellis.par.set'. 

  strict: This gets passed on directly to 'trellis.par.set'. 

_D_e_t_a_i_l_s:

     Getting and setting graphical parameters in 'flowViz' follows
     exactly the mechanism of the 'lattice' package. For all purpose
     and intentions, 'flowViz.par.get' and 'flowViz.par.get' can be
     viewed as wrappers around their 'lattice' counterparts
     'trellis.par.get' and 'trellis.par.set' and you should consult
     their documentation for further details.

     We introduce four new categories of graphical parameters that are
     relevant for 'flowViz' plots:


     _g_a_t_e Controls the appearance of gate boundaries in 'xyplots' (if
          'smooth=TRUE') or of the points within a gate region
          ('smooth=FALSE').  Available parameters are 'col',
          'cex','pch','alpha','lwd','lty' and 'fill'. 

     _g_a_t_e._d_e_n_s_i_t_y Controls the appearance of gate boundaries in
          'densityplots'.  Available parameters are 'col',
          'alpha','lwd','lty' and 'fill'. 

     _f_l_o_w._s_y_m_b_o_l Controls the appearance of 'regular' points in a
          'flowViz' plot.  Available parameters are 'col',
          'cex','pch','alpha' and 'fill'. 

     _g_a_t_e._t_e_x_t Controls the appearance of the text used for gate names.
           Available parameters are 'col', 'cex','font','alpha' and
          'lineheight'. 

_V_a_l_u_e:

     'flowViz.par.get' returns a list of graphical parameter defaults,
     if 'name' is not empty, only for this particular category. For an
     empty 'name' argument, the function returns all parameter
     defaults, including the ones specified in the lattice package.

     'flowViz.par.set' is called for its side-effects of setting
     default parameters.

_N_o_t_e:

     Because parameter settings in 'lattice' are device-dependent,
     'flowViz.par.get' will open a (default) device none is open at the
     time of the query.

_A_u_t_h_o_r(_s):

     F. Hahne

_R_e_f_e_r_e_n_c_e_s:

     Lattice, Multivariate Data Visualization with R.

     Deepayan Sarkar

     Springer, New York, 2008

_S_e_e _A_l_s_o:

     'trellis.par.get' and 'trellis.par.set'

_E_x_a_m_p_l_e_s:

     ## Return all available parameters, including lattice ones
     flowViz.par.get()

     ## Set the font for gate names 
     flowViz.par.set("gate.text", list(font=2))

     ## Query only the gate.text category
     flowViz.par.get("gate.text")

     ## Set a lattice parameter
     plot.symbol <- trellis.par.get("plot.symbol")
     flowViz.par.set("plot.symbol", list(col="red"))
     trellis.par.get("plot.symbol")

     ## undo all settings
     flowViz.par.set(list(plot.symbol=plot.symbol, gate.text=list(font=1)))

