SeasOpts                package:seas                R Documentation

_O_p_t_i_o_n_s _f_o_r _s_e_a_s

_D_e_s_c_r_i_p_t_i_o_n:

     Set default options for 'seas'.

_U_s_a_g_e:

     setSeasOpts()

_D_e_t_a_i_l_s:

     'setSeasOpts' sets all the default values for options in 'seas',
     and at some point it may support arguments for styles, such as
     'black and white'. However, after the initial setting of options,
     users may change the options to modify the look of graphics
     produced in 'seas'.

     Other details of the graphics can be modified using 'par'. This
     includes the font sizes, back-ground colour, font family, and many
     others. For example, setting 'par(cex=0.75)' will reduce the font
     size in the active device by  75% of the original size; while
     'par(font.main=2)' will change only the font for the main titles.

_V_a_l_u_e:

     'setSeasOpts()' only sets the 'options' in the current
     environment, and returns nothing.

     This is automatically done when 'seas' is loaded (using
     '.First.lib').

_O_p_t_i_o_n_s _u_s_e_d _i_n _s_e_a_s:

     Here are all the supported options for 'seas', with the default
     values shown for each option. Options are stored in 'list's, which
     make them easy to 'get', but difficult to 'set', and is shown in
     the _Examples_ section at the bottom.


     '_s_e_a_s._m_a_i_n': formating style for main title:

          '_f_m_t': format for 'name' and 'id' (if available) as the first
               '"%s"', followed by a range of years as the second
               '"%s"'; these are formated by 'sprintf'; '"%s\n%s"'

          '_r_n_g_s_e_p': separation between ranges of years; '"-"', other
               alternatives could be '" to "'

          '_s_h_o_w._i_d': show id (if available) in main title; 'TRUE'

          '_s_h_o_w._f_u_n': show function (where applicable) in main title;
               'TRUE'

     '_s_e_a_s._l_a_b_e_l': label formating for variables:

          '_f_m_t': label for name and units (if available); '"%s (%s)"',
               other alternatives could be '"%s, %s"'

          '_m_o_n_t_h_d_a_y': format for month and day (see 'strftime' for
               format codes); this can be either '"%b %-d"' (for most
               Unix-like systems), '"%b %#d"' (for Windows systems), or
               '"%b %d"' (for other systems); this should produce a
               string, such as 'Aug 1' for _August 1st_

          '_m_o_n_t_h' similar as previous, but when starting exactly on
               month-breaks; '"%B"'

          '_a_n_n' a label for 'image.seas.sum'; default is 'annual'


     '_s_e_a_s._m_o_n_t_h._g_r_i_d': setting for the display of the month grid (see
          '.seasmonthgrid'), which is common to many plots that use a
          'numeric' 'width' in 'mkseas':

          '_a_b_b': abbreviate month names for grid; 'TRUE'

          '_l_e_n': trim month name lengths to a number, for instance to
               get J|F|M|A|M|J|J|A|S|O|N|D, use '1'; 'NULL'

          '_f_o_r_c_e': force the display of each month label using 'mtext',
               otherwise labels can be automatically placed and
               adjusted for device using 'axis'; 'TRUE'

          '_l_a_b_e_l': show a month label on the grid; 'TRUE'

          '_c_o_l': colour for month grid; '"lightgrey"'

          '_l_w_d': width for month grid lines, multiplied by
               'par("lwd")'; '1'

          '_l_t_y': style for month grid lines; '1'


     '_s_e_a_s._b_x_p': attributes which affect the display of boxplots, used
          by various functions:

          '_b_o_x_c_o_l': default box-fill colour; '"lightgrey"'

          '_o_u_t_c_e_x': outlier symbol size, multiplied by 'par("cex")';
               '1'


     '_s_e_a_s._t_e_m_p': attributes which affect the display of
          'plot.seas.temp' (among other functions):

          '_c_o_l': colours for boxplot fill and diurnal variability
               lines; 'c("lightgrey","red")'

          '_l_w_d': width of diurnal variability lines in
               'plot.seas.temp', multiplied by 'par("lwd")'; '3'


     '_s_e_a_s._p_r_e_c_i_p': attributes which affect the display of
          precipitation:

          '_c_o_l': colour; '"grey"'

          '_d_e_n_s_i_t_y': pattern density; 'NULL'

          '_a_n_g_l_e': pattern angel; '45'

          '_l_w_d': thickness of box line, multiplied by 'par("lwd")'; '1'


     '_s_e_a_s._r_a_i_n': attributes which affect the display of rain:

          '_c_o_l': colour; '"lightblue"'

          '_d_e_n_s_i_t_y': pattern density; 'NULL'

          '_a_n_g_l_e': pattern angel; '45'

          '_l_w_d': thickness of box line, multiplied by 'par("lwd")'; '1'


     '_s_e_a_s._s_n_o_w': attributes which affect the display of snow:

          '_c_o_l': colour; '"lightgrey"'

          '_d_e_n_s_i_t_y': pattern density; 'NULL'

          '_a_n_g_l_e': pattern angel; '-45'

          '_l_w_d': thickness of box line, multiplied by 'par("lwd")'; '1'


     '_s_e_a_s._i_n_t_e_r_a_r_r_i_v_a_l': attributes which affect the display of wet-
          and dry-spells in 'plot.interarrival'; organized as
          'c(wet,dry)':

          '_c_o_l': colour; 'c("lightblue","orange")'


     '_s_e_a_s._m_e_d_i_a_n': attributes which affect the display of the 'median'
          lines in 'image.seas.sum':

          '_c_o_l': colour; '"red"'

          '_l_w_d': width of line, multiplied by 'par("lwd")'; '1'

          '_l_t_y': style of line; '1'


     '_s_e_a_s._m_e_a_n': attributes which affect the display of the 'mean'
          lines in 'image.seas.sum':

          '_c_o_l': colour; '"red"'

          '_l_w_d': width of line, multiplied by 'par("lwd")'; '1'

          '_l_t_y': style of line; '1'


     '_s_e_a_s._n_a': attributes which affect the display of 'NA' or missing
          values in various plots:

          '_c_o_l': colour; '"red"'

          '_p_c_h': character symbol; '"x"'


_A_u_t_h_o_r(_s):

     M.W. Toews

_S_e_e _A_l_s_o:

     'hidden'

_E_x_a_m_p_l_e_s:

     if(is.null(getOption("seas.main")))
       setSeasOpts()

     # Modify an option
     getOption("seas.main")$show.id
     cp <- orig <- getOption("seas.main")
     cp$show.id <- FALSE
     options(seas.main=cp)
     getOption("seas.main")$show.id

     options(seas.main=orig)

