make_plot_legend: Make color/size legend

Description Usage Arguments

View source: R/heat_tree--legend.R

Description

Make color/size legend

Usage

1
2
3
4
5
6
7
8
9
make_plot_legend(x, y, length, width_range, width_trans_range = NULL,
  width_stat_range, group_prefix, tick_size = 0.008,
  width_stat_trans = function(x) {     x }, width_title = "Size",
  width_sig_fig = 3, color_range, color_trans_range = NULL,
  color_stat_range, color_stat_trans = function(x) {     x },
  color_title = "Color", color_sig_fig = 3, divisions = 100,
  label_count = 7, title = NULL, label_size = 0.07, title_size = 0.08,
  axis_label_size = 0.08, color_axis_label = NULL, size_axis_label = NULL,
  hide_size = FALSE, hide_color = FALSE)

Arguments

x

bottom left

y

bottom left

length

(numeric of length 1) the length of the scale bar

width_range

(numeric of length 1 or 2) the width of the scale bar or the range

width_stat_range

(numeric of length 1 or 2) The stat range to display in the size labels

group_prefix

(character of length 1) The prefix of the group field in the shape data returned

tick_size

(numeric of length 1) the thickness of tick marks

width_stat_trans

(function) The transformation used to convert the statistic to size

width_title

(character of length 1) The title of the size labels.

width_sig_fig

(numeric of length 1) The number of significant figures to use in size labels.

color_range

(character) One ore more hex codes constituting a color scale.

color_stat_range

(numeric of length 1 or 2) The stat range to display in the color labels

color_stat_trans

(function) The transformation used to convert the statistic to size

color_title

(character of length 1) The title of the color labels.

color_sig_fig

(numeric of length 1) The number of significant figures to use in color labels.

divisions

(numeric of length 1) The number of colors to display.

label_count

(numeric of length 1) The number of labels.

title

(character of length 1) The title of the legend

axis_label_size

(numeric of length 1)

color_axis_label

(character of length 1) The label for the color axis

size_axis_label

(character of length 1) The label for the size axis

hide_size

(logical of length 1) If TRUE hide size axis

hide_color

(logical of length 1) If TRUE hide color axis


metacoder documentation built on May 30, 2017, 3:11 a.m.