Package arphit. March 28, 2019

Transcription

1 Type Package Title RBA-style R Plots Version Author Angus Moore Package arphit March 28, 2019 Maintainer Angus Moore < angusmoore@users.noreply.github.com> Easily create RBA-style graphs using R, using a ggplotlike syntax. Supports a range of common graph types, including multi layouts. License MIT + file LICENSE Encoding UTF-8 LazyData true Imports lubridate, tibble, stringr, plyr, dplyr, rlang, tidyr, devemf, zoo, xts, magick, writexl Suggests testthat, knitr, rmarkdown, covr RoxygenNote VignetteBuilder knitr R topics documented: +.arphit.gg

2 2 +.arphit.gg agg_abline agg_aes agg_arrow agg_autolabel agg_bgshading agg_col agg_draw agg_footnote agg_label agg_legend agg_line agg_point agg_qplot agg_shading agg_source agg_subtitle agg_title agg_units agg_xaxisfreq agg_xaxislabel agg_xlim agg_xunits agg_yaxislabel agg_ylim arphitgg print.arphit.gg RBA Index 23 +.arphit.gg Add a layer or element to an arphitgg graph. Add a layer or element to an arphitgg graph. ## S3 method for class 'arphit.gg' gg + element gg element An arphitgg built graph. The element to add to the graph.

3 agg_abline 3 agg_abline Add an AB line to your graph You need specify only one of x, or y, or x1,x2,y1,y2 agg_abline(x = NULL, y = NULL, x1 = NULL, y1 = NULL, x2 = NULL, y2 = NULL, color = "black",, lwd = 1, lty = 1) x y x1 y1 x2 y2 color lwd lty Draw a vertical line at x (omit to draw a specific AB line) Draw a horizontal at y omit to draw a specific AB line) For specific AB lines: the first x coordinate For specific AB lines: the first y coordinate For specific AB lines: the second x coordinate For specific AB lines: the second y coordinate (optional) The color of the AB line (default black) Which should the line be placed on? You can specify a vector of s (e.g. = c("1","3") ) to apply the line to multiple s at once. (Optional, default 1) The linewidth (Optional, default 1) The line type arphitgg(data) + agg_abline(x = 2001, color = RBA["Blue1"], = "1") + agg_abline(y = -0.5, color = RBA["Red1"], = "1") arphitgg(data) + agg_abline(x1 = 2000, y1 = -0.1, x2 = 2002, y2 = 0.5, color = RBA["Blue1"], = "1")

4 4 agg_arrow agg_aes Define an aesthetic for a graph, or a graph layer. If specified as part of a layer, fields left blank will be inherited from the parent. agg_aes(x, y, group = NULL, facet = NULL, order = NULL) x y group facet order The x variable The y variable If your data are in long form, which variable defines the groups If you data are in long form, which variable defines the facets (facets split data across s) Which variable to order the x-ticks by Tidy evaluation Aesthetics use tidy evaluation. This means any of can be expressions composed of variables in the data, rather than just variable names. For instance, you could do order = desc(some_variable), or y = my_variable^2. The vignette provides some examples of aesthetics using tidy evaluation. agg_arrow Add an arrow Add an arrow agg_arrow(tail.x, tail.y, head.x, head.y, color = "black",, lwd = 1)

5 agg_autolabel 5 tail.x tail.y head.x head.y color lwd The x coordinate of the arrow tail The y coordinate of the arrow tail The x coordinate of the arrow head The y coordinate of the arrow head The color of the arrow Which should the arrow be placed on? You can specify a vector of s (e.g. = c("1","3") ) to apply the arrow to multiple s at once. (Optional, default 1) The linewidth of the arrow arphitgg(data) + agg_arrow(tail.x = 2002, tail.y = 0, head.x = 2003, head.y = 1, color = RBA["Blue1"], = "1") agg_autolabel Add automatically placed label Add automatically placed label agg_autolabel(quiet = FALSE, arrow_bars = FALSE) quiet arrow_bars (logical, default FALSE) Do not output progress of autolabeller (logical, default FALSE) Add arrows between labels and bar series if there isn t line of sight between the label and the series. Line series always have arrows (if there isn t line of sight).

6 6 agg_bgshading data <- data.frame(x=1:10,y1=rnorm(10),y2=rnorm(10)) arphitgg(data,agg_aes(x=x)) + agg_line(agg_aes(y=y1)) + agg_line(agg_aes(y=y2)) + agg_autolabel() agg_bgshading Add background shading Add background shading agg_bgshading(x1 = NA, y1 = NA, x2 = NA, y2 = NA, color = RBA["Grey2"], ) x1 y1 x2 y2 color The bottom left x coordinate (omit to have the shading automatically snap to the edge of the ) The bottom left y coordinate (omit to have the shading automatically snap to the edge of the ) The top right x coordinate (omit to have the shading automatically snap to the edge of the ) The top right y coordinate (omit to have the shading automatically snap to the edge of the ) (optional) The color of the AB line (default grey) Which should the background shading be placed on? You can specify a vector of s (e.g. = c("1","3") ) to apply the shading to multiple s at once. arphitgg(data) + agg_bgshading(x1 = 2001, x2 = 2002, = "1") arphitgg(data) + agg_bgshading(y1 = 0.5, y2 = -0.5, = "1")

7 agg_col 7 agg_col Add a col layer to an arphit plot. Add a col layer to an arphit plot. agg_col(aes = NULL, data = NULL, color = NULL, barcol = NULL, = "1", stacked = TRUE) aes data color barcol stacked The aesthetic that defines the layer. Will inherit (or parts thereof) if omitted. The data to be used. Will inherit from parent if missing. A colour to be applied to all of the series, or (if your aesthetic has a group), a vector of colours that will be cycled through to consecutive group elements. (optional) Outline colours for each bar series (default = "1") Which of the graph to place this layer on. You can specify a vector of s (e.g. = c("1","3") ) to apply the layer to multiple s at once. (default = TRUE) Stack the bars, or group them? data <- data.frame(unemployment = rnorm(20), state = c(rep("a", 10), rep("b", 10)), date = seq.date(from = as.date(" "), length.out = 10, by = "quarter")) arphitgg(data) + agg_col(aes = agg_aes(x = date, y = unemployment, group = state), = "1")

8 8 agg_footnote agg_draw Draw a defined graph Draw a defined graph agg_draw(gg, filename = NULL) gg filename An arphitgg built graph. (optional) If specified, save image to filename instead of displaying in R. Supports png, pdf, emf, emf+, svg and xlsx extensions. agg_footnote Add a footnote (or many footnotes) Add a footnote (or many footnotes) agg_footnote(footnote) footnote A string, or vector of strings, to be added as footnotes. arphitgg(data) + agg_footnote("here is a footnote") arphitgg(data) + agg_footnote(c("here is a footnote", "And a second one"))

9 agg_label 9 agg_label Add a label Add a label agg_label(text, x, y,, color = "black", size = 20) text x y color The text to display on your plot The x coordinate of the center of your label The y coordinate of the center of your label Which should the label be placed on? You can specify a vector of s (e.g. = c("1","3") ) to apply the label to multiple s at once. The color of your text size Font size (default 20) arphitgg() + agg_label("here is a label", 2003, 0.2, "1", RBA["Red3"]) agg_legend Add a legend to the graph Add a legend to the graph agg_legend(ncol = NULL) ncol (optional) Specify the number of columns in the legend (if left blank, arphit will guess)

10 10 agg_line data <- data.frame(x = 1:10, y = 1:10) arphitgg(data) + agg_line(agg_aes(x = x, y = y)) + agg_legend() agg_line Add a line layer to an arphit plot. Add a line layer to an arphit plot. agg_line(aes = NULL, data = NULL, color = NULL, pch = NULL, lty = NULL, lwd = NULL, pointsize = 1, = "1") aes data color pch lty lwd The aesthetic that defines the layer. Will inherit (or parts thereof) if omitted. The data to be used. Will inherit from parent if missing. A colour to be applied to all of the series, or (if your aesthetic has a group), a vector of colours that will be cycled through to consecutive group elements. A point marker to be applied to all series, or or (if your aesthetic has a group), a vector of pch values that will be cycled through to consecutive group elements. Any value accepted by R for pch can be used. A line type to be applied to all series, or or (if your aesthetic has a group), a vector of lty values that will be cycled through to consecutive group elements. Any value accepted by R for lty can be used. A line width to be applied to all series, or or (if your aesthetic has a group), a vector of lwd values that will be cycled through to consecutive group elements. Any value accepted by R for lwd can be used. pointsize Scale the size of the points? (default 1) (default = "1") Which of the graph to place this layer on. You can specify a vector of s (e.g. = c("1","3") ) to apply the layer to multiple s at once.

11 agg_point 11 data <- data.frame(unemployment = rnorm(20), state = c(rep("a", 10), rep("b", 10)), date = seq.date(from = as.date(" "), length.out = 10, by = "quarter")) arphitgg(data) + agg_line(aes = agg_aes(x = date, y = unemployment, group = state), = "1") agg_point Add a scatter layer to an arphit plot. Add a scatter layer to an arphit plot. agg_point(aes = NULL, data = NULL, color = NULL, pointsize = 1, = "1") aes data color The aesthetic that defines the layer. Will inherit (or parts thereof) if omitted. The data to be used. Will inherit from parent if missing. A colour to be applied to all of the series, or (if your aesthetic has a group), a vector of colours that will be cycled through to consecutive group elements. pointsize Scale the size of the points? (default 1) (default = "1") Which of the graph to place this layer on. You can specify a vector of s (e.g. = c("1","3") ) to apply the layer to multiple s at once. data <- data.frame(x = rnorm(10), y = rnorm(10)) arphitgg(data) + agg_point(aes = agg_aes(x = x, y = y), = "1")

12 12 agg_qplot agg_qplot Quick plot - for quickly creates a single- graph. Supports bar and line (and combinations of). Quick plot - for quickly creates a single- graph. Supports bar and line (and combinations of). agg_qplot(data, series = NULL, x = NULL, bars = FALSE, filename = NULL, title = NULL, subtitle = NULL, footnotes = c(), sources = c(), yunits = NULL, col = list(), pch = list(), lty = list(), lwd = list(), xlim = NULL, ylim = NULL, legend = FALSE, legend.ncol = NA, bar.stacked = TRUE) data series x bars filename title subtitle footnotes sources yunits col pch Object containing the series you want to plot. Can be a data.frame, tibble, zoo, xts or ts. A vector of series names specifying which subset of series you want to plot. The x variable for your plot. Not required for ts, xts and zoo data because they use the dates in the time series. (optional) Vector of string names indicating which series should be bars, rather than lines. Alternatively, if you set bars = TRUE all series will plot as bars. (optional) If specified, save image to filename instead of displaying in R. Supports svg, pdf, emf, emf+ and png extensions. (optional) A string indicating the title for the graph. Passing NULL (or omitting the argument) will suppress printing of title. (optional) A string indicating the subtitle for the graph. Passing NULL (or omitting the argument) will suppress printing of subtitle. (optional) A vector strings, corresponding to the footnotes, in order. (optional) A vector of strings, one entry for each source. (optional) A string indicating the units to be used. If not supplied, a % sign will be used. (optional) A list of string -> misc pairs. The keys should be series names, and the values colours for each series (any colour accepted by R is fine.) You need not supply colours for all series. Default colours will be assigned (cycling through) to series without assigned colours. Alternatively, you can supply a single value to apply to all series. (optional) Markers for your series. Passed as with col. Defaults to none (NA). lty (optional) Line types for each series. Passed as with col. Defaults to solid (1). lwd (optional) Line width, relative to default, for each series. Passed as with col.

13 agg_shading 13 xlim ylim legend legend.ncol bar.stacked (optional) c(numeric, numeric) Gives the x limits (in years) for the graph. (optional) A list(min = numeric, max = numeric, nsteps int). If unsupplied, a suitable default is chosen. A logical indicating whether to add a legend to the graph (default FALSE). (optional) How many columns do you want the legend to have (if NA, which is the default, arphit will guess for you). (optional) Logical indicating whether the bar series should be stacked (TRUE, default) or side-by-side (FALSE). vignette("qplot-options", package = "arphit") for a detailed description of all the plotting options and how they affect the output. T <- 24 randomdata <- ts(data.frame(x1 = rnorm(t), x2 = rnorm(t), x3 = rnorm(t, sd = 10), x4 = rnorm(t, sd = 5)), start = c(2000,1), frequency = 4) agg_qplot(randomdata, title = "A Title", subtitle = "A subtitle", footnotes = c("a","b"), sources = c("a Source", "Another source"), yunits = "index") agg_shading Add shading between series Add shading between series agg_shading(from, to, = NULL, color = RBA["Grey2"]) from to color The series name to shade from (if you have no group aesthetic, it will be the name of the y variable); if you have groups, it will (usually) be the group identifier. This can get more complicated if you have duplicate group names. If so, arphit appends.y to the group names, so try that.) The name of the series to shade to (optional) Which are the relevant series in? (arphit will try to find them if you don t specify) (optional) The color to shade between the series (default grey)

14 14 agg_source data <- data.frame(date = seq.date(from = as.date(" "), length.out = 12, by = "month"), x1 = rnorm(12), x2 = rnorm(12)) arphitgg(data, agg_aes(x = date)) + agg_line(agg_aes(y = x1), color = RBA["Blue2"]) + agg_line(agg_aes(y = x2), color = RBA["Red4"]) + agg_shading(from = x1, to = x2) agg_source Add a source (or many sources) Add a source (or many sources) agg_source(source) source A string, or vector of strings, to be added as sources arphitgg(data) + agg_source("source 1") arphitgg(data) + agg_source(c("source 1", "Source 2"))

15 agg_subtitle 15 agg_subtitle Add a subtitle or subtitle Add a subtitle or subtitle agg_subtitle(text, = NULL) text A string for the subtitle. (optional) Specify a identifier to add a subtitle instead of an overall graph subtitle. You can specify a vector of s (e.g. = c("1","3") ) to apply the subtitle to multiple s at once. arphitgg(data) + agg_subtitle("graph Subtitle") arphitgg(data) + agg_subtitle("panel subtitle", = "1") agg_title Add a title or title Add a title or title agg_title(text, = NULL) text A string for the title. (optional) Specify a identifier to add a title instead of an overall graph title. You can specify a vector of s (e.g. = c("1","3") ) to apply the title to multiple s at once.

16 16 agg_units arphitgg(data) + agg_title("graph Title") arphitgg(data) + agg_title("panel title", = "1") agg_units Add units (for the y axis) Add units (for the y axis) agg_units(units, = NULL) units A string specifying the units. (optional) Specify a identifier to add to a specific. If blank, units will be applied to all s. You can specify a vector of s (e.g. = c("1","3") ) to apply the units to multiple s at once. arphitgg(data) + agg_units("index") arphitgg(data) + agg_units("ppt", = "1")

17 agg_xaxisfreq 17 agg_xaxisfreq Specify the frequency of the x ticks for time series graphs Specify the frequency of the x ticks for time series graphs agg_xaxisfreq(freq, = NULL) freq The frequency, either "decade", "year", "quarter", "month" (optional) Which to apply the frequency scale to. If left blank, will be applied to all s. You can specify a vector of s (e.g. = c("1","3") ) to apply the frequency to multiple s at once. agg_xaxislabel Add an axis label to the x axis Add an axis label to the x axis agg_xaxislabel(axislabel, = NULL) axislabel A string specifying the axis label (optional) Specify a identifier to add to a specific. If blank, axis label will be applied to all s. You can specify a vector of s (e.g. = c("1","3") ) to apply the axis to multiple s at once.

18 18 agg_xlim arphitgg(data) + agg_xaxislabel("year") agg_xlim Specify the x limits for a graph Specify the x limits for a graph agg_xlim(min, max, = NULL) min max The minimum for the x-axis (can be NA to have arphit guess, based on your data) The maximum (can also be NA, as above) (optional) Which to apply the scale to. If left blank, will be applied to all s. This is recommended. You can specify a vector of s (e.g. = c("1","3") ) to apply the limits to multiple s at once. arphitgg(data) + agg_xlim(min = -10, max = 10) arphitgg(data) + agg_xlim(min = -10, max = 10, = "1")

19 agg_xunits 19 agg_xunits Add units to the x axis (only works for scatter graphs) Add units to the x axis (only works for scatter graphs) agg_xunits(units, = NULL) units A string specifying the units. (optional) Specify a identifier to add to a specific. If blank, units will be applied to all s. You can specify a vector of s (e.g. = c("1","3") ) to apply the units to multiple s at once. arphitgg(data) + agg_xunits("index") agg_yaxislabel Add an axis label to the y axis Add an axis label to the y axis agg_yaxislabel(axislabel, = NULL) axislabel A string specifying the axis label (optional) Specify a identifier to add to a specific. If blank, axis label will be applied to all s. You can specify a vector of s (e.g. = c("1","3") ) to apply the axis label to multiple s at once.

20 20 agg_ylim arphitgg(data) + agg_yaxislabel("some y axis label") agg_ylim Specify the y scale for a graph Specify the y scale for a graph agg_ylim(min, max, nsteps, = NULL) min max nsteps The minimum for the y-axis The maximum The number of steps (includes the minimum and maximum) (optional) Which to apply the scale to. If left blank, will be applied to all s. You can specify a vector of s (e.g. = c("1","3") ) to apply the scale to multiple s at once. arphitgg(data, layout = "2b2") + agg_ylim(min = -10, max = 10, nsteps = 5) arphitgg(data, layout = "2b2") + agg_ylim(min = -10, max = 10, nsteps = 5, = "1")

21 arphitgg 21 arphitgg Create an new arphit graph Create an new arphit graph arphitgg(data = NULL, aes = NULL, layout = "1", portrait = FALSE, dropxlabel = FALSE, srt = 0, showallxlabels = NULL, joined = TRUE, plotsize = LANDSCAPESIZE, log_scale = "") data aes layout portrait dropxlabel srt (Optional) Data to be used for the plot. Can be left blank, but must then be supplied for each layer. (Optional) The aesthetic that defines your graph. Can be left blank, but must then be supplied for each layer. Layers that don t specify aesthetics will inherit missing parts of aesthetic from here. (default = "1") The layout of the graph. Valid options are "1", "2v", "2h", "2b2", "3v", "3h", "3b2", "4h", "4b2". (default = FALSE) Logical indicating whether the layout should be a landscape size (FALSE, default), or a taller portrait size (TRUE). (optional) Logical indicating whether the first xlabel of right hand s in 2v and 2b2 should be ignored (prevents overlapping of last xlabel on left with first on right). FALSE by default. (default 0) Orientation adjustment for xlabels. In degrees; 0 is horizontal. showallxlabels (optional) (Only for categorical graphs) Force all x labels to show? By default, this is TRUE. joined plotsize log_scale (default TRUE) Logical indicating whether you want to join between missing observations (TRUE()), or break the series (FALSE). (optional) A vector of two variables specifying the height and width of your graph, respectively. (Default 5.53, 7.5). Ignored if portrait is set to TRUE (optional) Set one or both of y and x axes as log scales? Use "y" for just y axis, "x" for just x and "xy" for both

22 22 RBA print.arphit.gg Draw a defined graph Draw a defined graph ## S3 method for class 'arphit.gg' print(x,...) x An arphitgg built graph.... Further arguments passed to or from other methods. RBA RBA colour palette A list of RBA-standard colours to use. Use them by using RBA["Red1"] in a colour declaration. For instance: RBA Format Details An object of class character of length 117. arphit.tsgraph(data, col = list("x2" = RBA["Red1"], "x4" = RBA["Green3"])) To see a list of all the available colours, type vignette("rbacolours")

23 Index Topic datasets RBA, 22 +.arphit.gg, 2 agg_abline, 3 agg_aes, 4 agg_arrow, 4 agg_autolabel, 5 agg_bgshading, 6 agg_col, 7 agg_draw, 8 agg_footnote, 8 agg_label, 9 agg_legend, 9 agg_line, 10 agg_point, 11 agg_qplot, 12 agg_shading, 13 agg_source, 14 agg_subtitle, 15 agg_title, 15 agg_units, 16 agg_xaxisfreq, 17 agg_xaxislabel, 17 agg_xlim, 18 agg_xunits, 19 agg_yaxislabel, 19 agg_ylim, 20 arphitgg, 21 print.arphit.gg, 22 RBA, 22 23