scatter_plot: Generates a scatter plot. If additional argument added, a...

Description Usage Arguments Value Examples

View source: R/scatter_and_bubble_plot.R

Description

Generates a scatter plot. If additional argument added, a bubble plot is generated.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
scatter_plot(
  data,
  x,
  y,
  cat = NULL,
  x_space_size = NULL,
  y_space_size = NULL,
  x_names = c("x", ""),
  y_names = c("y", ""),
  legend_title = "Legend",
  bubble_value = NULL,
  x_start = 0,
  x_end = max(get_vector(data, x)),
  y_start = 0,
  y_end = max(get_vector(data, y))
)

Arguments

data

data frame containing data to be plotted

x

string containing a column name or a vector containing x - coordinates of values

y

string containing a column name or a vector containing y - coordinates of values

cat

string containing a column name or a vector containing categories of the values

x_space_size, y_space_size

numeric value of the space between the ticks on the x,y - axis. Defaultly, axis will be divided into 8 sections

x_names

vector containing two values: * name of the value presented on the x - axis * units of values presented on the x - axis

y_names

vector containing two values: * name of the value presented on the y - axis * units of values presented on the y - axis

legend_title

title of the legend

bubble_value

vector containing values defining the size of bubbles. Set by default to NULL.

x_start

numeric value defining where the x axis should start at. Set by default to 0.

x_end

numeric value defining where the x axis should end at. Set by default to max(x).

y_start

numeric value defining where the y axis should start at. Set by default to 0.

y_end

numeric value defining where the y axis should end at. Set by default to max(y).

Value

object of class tidychart with a character vector containing SVG elements

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# prepare a data frame
data <- data.frame(
    x = c(2, -3, -5, 5.5, 7, 9, 2.5, 1, 5, 5.3, 8.5, 6.6),
    value = c(5,-3,2,6, 7, 3, -2, 1,7,8,3, -5),
    cat = c("val1","val1","val2","val2","val2",
            "val3","val3","val3", "val4","val4","val4","val4"),
    bubble = c (1,2,12,4,5,4,8,2,1,9, 8, 4.5 )
)

# generate character vectors with svg data
scatter <- scatter_plot(
  data = data,
  x = data$x,
  y = data$value,
  cat = data$cat,
  x_space_size = 2,
  y_space_size = 1,
  x_names = c("time", "in s"),
  y_names = c("distance", "in km"),
  legend_title = "Legend")

bubble <-scatter_plot(
  data = data,
  x = data$x,
  y = data$value,
  cat = data$cat,
  x_space_size = 2,
  y_space_size = 1,
  x_names = c("time", "in s"),
  y_names = c("distance", "in km"),
  legend_title = "Legend",
  bubble_value = data$bubble)

# show the plots
scatter
bubble

tidycharts documentation built on Jan. 18, 2022, 5:07 p.m.