plot_nested: Plot Nested

Description Usage Arguments Details Value See Also Examples

View source: R/plot_nested.R

Description

Plots a nested chart, showing several tests and their facets in a global chart.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
plot_nested(coord, size = 1, filename = "myipv.pdf", filewidth = 10,
  fileheight = 10, cor_labels_tests = TRUE, cor_labels_facets = TRUE,
  colour_tests = "black", colour_facets = "black", fade = 85,
  font = "sans", show_xarrows = FALSE, tick = 0.1, size_title = 1,
  size_test_labels = 1, size_facet_labels = 1, width_axes = 1,
  width_axes_inner = 1, width_circles = 1, width_circles_inner = 1,
  width_tick = 1, width_tick_inner = 1, size_tick_label = 1,
  size_cor_labels = 1, size_cor_labels_inner = 1, size_center_dot = 1,
  size_center_dot_inner = 1, width_xarrows = 1, size_xarrow_heads = 1,
  size_xarrow_labels = 1)

Arguments

coord

list generated by coord_nested.

size

integer; smartly scaled size of chart objects.

filename

character; name of the file to save. Supported formats are: "pdf" (best quality with lowest file size), "png", "jpeg". Use "none" to suppress file output; defaults to "myipv.pdf".

filewidth

integer; width of the .pdf file; defaults to 10, dpi is 3000.

fileheight

integer; height of the .pdf file; defaults to 10, dpi is 3000.

cor_labels_tests

logical; if TRUE, draws latent correlations between tests as text.

cor_labels_facets

logical; if TRUE, draws latent correlations between facets as text.

colour_tests

character; name of the global accent colour.

colour_facets

character; name of the nested accent colour.

fade

integer; brightness of the gray tones between 0 (black) and 100 (white) in steps of 1; defaults to 85.

font

character; text font; defaults to 'sans' (use extrafonts to install additional fonts).

show_xarrows

logical; if TRUE, draws correlation arrows between facets of different tests.

tick

numeric; axis tick position; defaults to .1.

size_title

integer; font size of the global label (relative to default).

size_test_labels

integer; font size of the test labels (relative to default).

size_facet_labels

integer; font size of the facet labels (relative to default).

width_axes

integer; width of the global radial axis lines indicating center distances (relative to default).

width_axes_inner

integer; width of the nested radial axis lines indicating center distances (relative to default).

width_circles

integer; width of the global circle outlines (relative to default).

width_circles_inner

integer; width of the nested circle outlines (relative to default).

width_tick

integer; width of the global dotted axis tick line (relative to default).

width_tick_inner

integer; width of the nested dotted axis tick line (relative to default).

size_tick_label

integer; font size of the axis tick label (relative to default).

size_cor_labels

integer; font size of the latent correlations between tests (relative to default).

size_cor_labels_inner

integer; font size of the latent correlations between facets (relative to default).

size_center_dot

integer; size of the center dot marking the global origin (relative to default).

size_center_dot_inner

integer; size of the center dots marking the nested origins (relative to default).

width_xarrows

integer; width of the extra arrow lines (relative to default).

size_xarrow_heads

integer; length of the extra arrow heads (relative to default).

size_xarrow_labels

integer; font size of the latent correlations indicated by extra arrows (relative to default).

Details

Use this function in conjunction with coord_nested for nested models.

Use nested_chart to create the chart in a single step.

The following changes to the chart appearance are made using coord_nested, not this function:

When changing the size of objects, consider the size parameter first and make specific adjustments with the other size_ and width_ parameters after.

The nested chart treats tests like facets of a global factor. It uses facet charts for tests similar to how facet charts use circles for facets.

To add xarrows, you need to provide additional information to coord_nested.

Value

Object of the class "ggplot" and optionally the same object saved as a file.

See Also

coord_nested nested_chart

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# # creating nested charts is a two step process, using coord_nested and this
# # function:
# coord <- coord_nested(self_confidence, subradius = .6)
# sc_nested <- plot_nested(coord, filename = "sc_nested.pdf")
# sc_nested
#
# # adding xarrows
# sc_arrows <- data.frame(test1 = rep(NA, 3),
#                          facet1 = NA,
#                          test2 = NA,
#                          facet2 = NA,
#                          value = NA)
# sc_arrows[1, ] <- c("DSSEI", "Ab", "RSES", "Ps", ".67")
# sc_arrows[2, ] <- c("DSSEI", "Ab", "SMTQ", "Cs", ".81")
# sc_arrows[3, ] <- c("SMTQ", "Ct", "RSES", "Ns", ".76")
# coord <- coord_nested(self_confidence, subradius = .6, xarrows = sc_arrows)
# sc_nested <- plot_nested(coord, filename = "sc_nested.pdf", show_xarrows = TRUE)
# sc_nested

NilsPetras/IPV documentation built on Dec. 7, 2018, 8:55 a.m.