Type:	Package
Title:	Generate Tidy Charts Inspired by 'IBCS'
Version:	0.1.3
Maintainer:	Bartosz Sawicki <sawicki.bartosz@interia.pl>
Description:	There is a wide range of R packages created for data visualization, but still, there was no simple and easily accessible way to create clean and transparent charts - up to now. The 'tidycharts' package enables the user to generate charts compliant with International Business Communication Standards ('IBCS'). It means unified bar widths, colors, chart sizes, etc. Creating homogeneous reports has never been that easy! Additionally, users can apply semantic notation to indicate different data scenarios (plan, budget, forecast). What's more, it is possible to customize the charts by creating a personal color pallet with the possibility of switching to default options after the experiments. We wanted the package to be helpful in writing reports, so we also made joining charts in a one, clear image possible. All charts are generated in SVG format and can be shown in the 'RStudio' viewer pane or exported to HTML output of 'knitr'/'markdown'.
URL:	https://mi2datalab.github.io/tidycharts/, https://github.com/MI2DataLab/tidycharts
License:	GPL (≥ 3)
Encoding:	UTF-8
RoxygenNote:	7.1.1
Imports:	magick, rsvg, rlang, testthat, methods, graphics, htmlwidgets, lubridate, stringr
Depends:	magrittr, knitr
Suggests:	rmarkdown, palmerpenguins, tidyverse, dplyr, covr
VignetteBuilder:	knitr
NeedsCompilation:	no
Packaged:	2022-01-18 11:18:14 UTC; sawcio
Author:	Przemysław Biecek [aut], Piotr Piątyszek [aut], Kinga Ułasik [aut], Bartosz Sawicki [aut, cre]
Repository:	CRAN
Date/Publication:	2022-01-18 16:00:02 UTC

Function to render SVG image as htmlwidget

Description

Use this function to show SVG images from given string in SVG embedded in HTML.

Usage

SVGrenderer(svg_string, width = NULL, height = NULL, elementId = NULL)

Arguments

Value

No return value, called for side effects

Save svg image.

Description

Save svg image.

Usage

SVGsave(svg_string, path)

Arguments

Value

No return value, called for side effects

add bars to svg string

Description

add bars to svg string

Usage

add_bars(
  svg_string,
  df,
  x,
  series,
  bar_width,
  styles = NULL,
  x_offset = 0,
  translate = c(0, 0),
  add_x_axis = TRUE,
  color = NULL,
  add_legend = FALSE,
  legend_position = "left_top",
  max_val = NULL
)

Arguments

Value

svg string with added bars

Add IBCS compliant legend.

Description

Add IBCS compliant legend.

Usage

add_title(svg_string, line1, line2_measure, line2_rest, line3 = "")

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

df <- data.frame(x = 2010:2015, sales = rnorm(6,10, 2))
column_chart(df, df$x, 'sales') %>%
  add_title(line1 = 'Department of Big Computers',
    line2_measure = "Sales",
    line2_rest = "in mEUR",
    line3 = "2010..2015")

Add waterfall style bars to the column chart

Description

Add waterfall style bars to the column chart

Usage

add_waterfall_bars(
  svg_string,
  df,
  x,
  series,
  bar_width,
  styles = NULL,
  pos_color = "rgb(64,64,64)",
  neg_color = "black",
  add_result_bar = TRUE,
  result_bar_pos = "1",
  positive_prefix = "",
  result_bar_color = NULL,
  result_title = NULL,
  ref_value = 0,
  translate_vec = c(0, 0)
)

Arguments

Value

svg string with appended waterfall bars

Generates basic horizontal barchart. If more than one series is supplied, stacked barchart is generated.

Description

Generates basic horizontal barchart. If more than one series is supplied, stacked barchart is generated.

Usage

bar_chart(data, cat, series, series_labels = series, styles = NULL)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#prepare the data frame
data <- data.frame(
city = c("Berlin", "Munich", "Cologne", "London", "Vienna", "Paris", "Zurich"),
Products = c(538, 250, 75, 301, 227, 100, 40),
Services = c(621, 545, 302, 44, 39, 20, 34)
)
#generate svgstring
barchart <- bar_chart(data, data$city, c("Products", "Services"), c("Products", "Services"))

#show the plot
barchart

Generate bar chart with absolute variance.

Description

Visualize variance between baseline and real in absolute units. Choose colors parameter accordingly to business interpretation of larger/smaller values.

Usage

bar_chart_absolute_variance(
  data = NULL,
  cat,
  baseline,
  real,
  colors = 1,
  y_title,
  y_style = "previous"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

# get some data
real <- sin(1:5)
baseline <- cos(1:5)
cat <- letters[1:5]

bar_chart_absolute_variance(
  cat = cat,
  baseline = baseline,
  real = real,
  y_title = 'a title')

Generates grouped horizontal barchart with scenario triangles.

Description

Generates grouped horizontal barchart with scenario triangles.

Usage

bar_chart_grouped(
  data,
  cat,
  foreground,
  background,
  markers = NULL,
  series_labels,
  styles = NULL
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#preparing data frames
data <- data.frame(
city = c("Berlin", "Paris", "London", "Munich", "Vienna"),
AC = c(592, 1166, 618, 795, 538),
PL = c(570, 950, 800, 780, 460),
triangles = c(545, 800, 900, 600, 538) #AC toten bardziej na wierzchu
)

#preparing the styles data frame
df_styles <- data.frame(
 AC = c("actual","actual","actual","actual","actual"),
 PL = c("plan","plan","plan","plan","plan"),
 triangles = c("previous", "previous","previous","previous","previous"))

#creating the svg string
barchart_grouped <- bar_chart_grouped(data,
 data$city,  "AC", "PL","triangles", c("triangles", "AC", "PL"), df_styles)

#showing the plot
barchart_grouped

Generates normalized horizontal barchart. If more than one series is supplied, stacked barchart is generated.

Description

Generates normalized horizontal barchart. If more than one series is supplied, stacked barchart is generated.

Usage

bar_chart_normalized(data, cat, series, series_labels = series)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#prepare the data frame
data <- data.frame(
city = c("Berlin", "Munich", "Cologne", "London", "Vienna", "Paris", "Zurich"),
Products = c(538, 250, 75, 301, 227, 100, 40),
Services = c(621, 545, 302, 44, 39, 20, 34)
)
#create svg string
barchart_normalized <- bar_chart_normalized(
  data = data,
  cat = data$city,
  series = c("Products", "Services"))

#show the plot
barchart_normalized

Generates basic horizontal barchart with index on a given value. If more than one series is supplied, stacked barchart is generated.

Description

Generates basic horizontal barchart with index on a given value. If more than one series is supplied, stacked barchart is generated.

Usage

bar_chart_reference(
  data,
  cat,
  series,
  ref_val,
  series_labels = series,
  styles = NULL,
  ref_label = ref_val
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#prepare the data frame
data <- data.frame(
city = c("Berlin", "Munich", "Cologne", "London", "Vienna", "Paris", "Zurich"),
Products = c(538, 250, 75, 301, 227, 100, 40),
Services = c(621, 545, 302, 44, 39, 20, 34)
)
#create svg string
barchart_ref <- bar_chart_reference(data, data$city, c("Products"), 100, c("Products"))

#show the plot
barchart_ref

Generate bar chart with relative variance (in percents).

Description

Generate bar chart with relative variance (in percents).

Usage

bar_chart_relative_variance(
  data = NULL,
  cat,
  baseline,
  real,
  colors = 1,
  y_title,
  y_style = "previous",
  styles = NULL
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

# get some data
real <- sin(1:5)
baseline <- cos(1:5)
cat <- letters[1:5]

bar_chart_relative_variance(
  cat = cat,
  baseline = baseline,
  real = real,
  y_title = 'a title')

Generate horizontal waterfall chart.

Description

Generate horizontal waterfall chart.

Usage

bar_chart_waterfall(
  cat,
  series,
  data = NULL,
  add_result = FALSE,
  result_title = NULL
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

df <- data.frame(
  city = c("Berlin", "Munich", "Cologne", "London", "Vienna", "Paris", "Zurich"),
  profit = sin(1:7)
)

bar_chart_waterfall(cat = 'city', series = 'profit', data = df)

Generate basic column chart.

Description

If more than one series is supplied, stacked column plot is generated.

Usage

column_chart(
  data,
  x,
  series = NULL,
  series_labels = series,
  styles = NULL,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

# prepare some data frame
df <- data.frame(x = month.abb[1:6],
                 y = c(2, 4, 2, 1, 2.5, 3),
                 z = c(3, 4.5, 2, 1, 4, 2))

# generate character vectors with svg data
svg1 <- column_chart(df, x = 'x', series = 'y')
svg2 <- column_chart(df, x = df$x, series = c('y', 'z'))


# show the plot
svg1

Generate column chart with absolute variance.

Description

Visualize variance between two time series (baseline and real) in the same units as the time series. Choose colors parameter accordingly to business interpretation of larger/smaller values.

Usage

column_chart_absolute_variance(
  x,
  baseline,
  real,
  colors = 1,
  data = NULL,
  x_title = "PY",
  x_style = "previous",
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

x <- month.abb
baseline <- rnorm(12)
real <- c(rnorm(6, mean = -1), rnorm(6, mean = 1))
column_chart_absolute_variance(x, baseline, real, x_title = 'profit')

Generate grouped column chart for visualizing up to 3 data series.

Description

Generate grouped column chart for visualizing up to 3 data series.

Usage

column_chart_grouped(
  x,
  foreground,
  background,
  markers = NULL,
  data = NULL,
  series_labels,
  styles = NULL,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

df <- data.frame(x = month.abb[7:12],
                 actual = rnorm(6, mean = 5, sd = 0.3),
                 budget = rnorm(6, mean = 4.5, sd = 0.7),
                 prev_year = rnorm(6, mean = 4))

column_chart_grouped(x = df$x,
                     foreground = df$actual,
                     background = df$budget,
                     markers = df$prev_year,
                     series_labels = c('AC', 'BU', 'PY'))

Generate column chart with normalization.

Description

Every column will be rescaled, so columns have the same height.

Usage

column_chart_normalized(
  data,
  x,
  series = NULL,
  series_labels = series,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

# prepare some data frame
df <- data.frame(x = month.abb[1:6],
                 y = c(2, 4, 2, 1, 2.5, 3),
                 z = c(3, 4.5, 2, 1, 4, 2))

# generate character vector with svg data
column_chart_normalized(df, x = df$x, series = c('y', 'z'))

Generate column chart with reference line.

Description

Generate column chart with reference line.

Usage

column_chart_reference(
  data,
  x,
  series,
  ref_value,
  ref_label = NULL,
  styles = NULL,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

# prepare some data frame
df <- data.frame(x = month.abb[1:6],
                 y = c(2, 4, 2, 1, 2.5, 3),
                 z = c(3, 4.5, 2, 1, 4, 2))

# generate character vector with svg data
column_chart_reference(df, x = 'x',
                       series = 'y',
                       ref_value = 3,
                       ref_label = 'baseline')

Generate column chart with relative variance (in percents).

Description

Generate column chart with relative variance (in percents).

Usage

column_chart_relative_variance(
  x,
  baseline,
  real,
  colors = 1,
  data = NULL,
  x_title,
  x_style = "previous",
  styles = NULL,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

x <- month.abb
baseline <- rnorm(12, mean = 1, sd = 0.2)
real <- c(rnorm(6, mean = 0.8, sd = 0.2), rnorm(6, mean = 1.2, sd = 0.2))
column_chart_relative_variance(x, baseline, real, x_title = 'profit %')

Generate column waterfall chart for visualizing contribution.

Description

Generate column waterfall chart for visualizing contribution.

Usage

column_chart_waterfall(data, x, series, styles = NULL, interval = "months")

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

df <- data.frame(x = 10:18,
                 y = rnorm(9))
column_chart_waterfall(df, 'x', 'y')

Generate column waterfall chart with absolute variance.

Description

Generate column waterfall chart with absolute variance.

Usage

column_chart_waterfall_variance(
  x,
  baseline,
  real,
  colors = 1,
  data = NULL,
  result_title,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

x <- month.abb
baseline <- rnorm(12)
real <- c(rnorm(6, mean = -1), rnorm(6, mean = 1))
column_chart_waterfall_variance(x, baseline, real, result_title = 'year profit')

Draw triangle and append it to svg string

Description

Draw triangle and append it to svg string

Usage

draw_triangle(
  svg_string,
  tip_position_x,
  tip_position_y,
  orientation = "left",
  style = NULL,
  translate_vec = c(0, 0)
)

Arguments

Value

svg string

Facet chart.

Description

Create multiple charts with data split into groups.

Usage

facet_chart(data, facet_by, ncols = 3, FUN, ...)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

facet_chart(
  data = mtcars,
  facet_by = 'cyl',
  ncols = 2,
  FUN = scatter_plot,
  x = mtcars$hp,
  y = mtcars$qsec,
  legend_title = ''
 )

Function to get bar/area color for stacked plots.

Description

Function to get bar/area color for stacked plots.

Usage

get_color_stacked(series_number, colors_df = pkg.env$colors_df)

Arguments

Value

list with bar_color and text_color

Helper function to get the vector or column form df. If vector is passed it returns it. If name of column is passed, it returns the column as a vector.

Description

Helper function to get the vector or column form df. If vector is passed it returns it. If name of column is passed, it returns the column as a vector.

Usage

get_vector(df, vec)

Arguments

Value

vector

Join SVG charts.

Description

This function first populates each place in the first row, then columns in the second row.

Usage

join_charts(
  ...,
  nrows = max(length(list(...)), length(list_of_plots)),
  ncols = 1,
  list_of_plots = NULL
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

  df <- data.frame(
   mon = month.abb[1:6],
   values = rnorm(6)
  )

join_charts(
  column_chart(df, x = 'mon', series = 'values'),
  column_chart(df, x = 'mon', series = 'values')
)

Printing in knitr reports

Description

Normally you don't want to use this function explicitly. It is called automatically when printing output in knitr.

Usage

## S3 method for class 'tidychart'
knit_print(x, ...)

Arguments

Value

object of class 'html_screenshot' or 'knit_asis'

Generates a line plot with markers on chosen points. Allows only one point per time interval. To create a plot with many points within one time interval try 'line_chart_dense'.

Description

Generates a line plot with markers on chosen points. Allows only one point per time interval. To create a plot with many points within one time interval try 'line_chart_dense'.

Usage

line_chart(
  data,
  x,
  series,
  series_labels,
  ser_names,
  point_cords,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#preparing the data frame
data <- data.frame(
time = c(2015, 2016, 2017, 2018, 2019, 2020),
Gamma = c(98, 80, 16, 25, 55, 48),
Delta = c(22, 25, 67, 73, 102, 98)
)

#defining rest of arguments
names <- c("Gamma", "Gamma", "Gamma","Gamma","Delta", "Delta")
cords <- c(1, 4,5,2, 5,4)

#generating SVG string
line_chart  <- line_chart(
  data = data,
  x = data$time,
  series = c("Gamma", "Delta"),
  series_labels =c("Gamma inc.", "Delta inc."),
  ser_names = names,
  point_cords = cords,
  interval = "years")

#showing the plot
line_chart

Line chart with more points then categories on x-axis.

Description

Line chart with more points then categories on x-axis.

Usage

line_chart_dense(data, dates, series, interval = "months")

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

df <- data.frame(
 x = seq.Date(as.Date('2021-01-01'), as.Date('2021-07-01'), length.out = 200),
 'Company_sin' = 5 * sin(seq(
   from = 0,
   to = 2 * pi,
   length.out = 200
   )) +  rnorm(200, mean = 5, sd = 0.5),
 'Company_cos' = 5 * cos(seq(
   from = 0,
   to = 2 * pi,
   length.out = 200
 )) +  rnorm(200, mean = 5, sd = 0.5))

df <- head(df, n = 199)

line_chart_dense(
  df,
  dates = 'x',
  series = c('Company_sin', 'Company_cos'))

More customizable version of 'line_chart_dense'. User can choose the points to highlight.

Description

More customizable version of 'line_chart_dense'. User can choose the points to highlight.

Usage

line_chart_dense_custom(
  list,
  vector_x,
  vector_y,
  vector_cat,
  series_labels,
  df_numbers = NULL,
  point_cords = NULL,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#preparing data frames
data <- data.frame(
xdata = c(1, 60,90, 30, 60, 90, 30, 60, 90, 45,95,45, 95),
ydata = c(5, -10, -15, 11, 16, 18, 25, 22, 18, 10, 8, 23, 28),
catdata = c("Jan","Jan", "Jan", "Feb","Feb", "Feb", "Mar",
"Mar", "Mar", "Apr", "Apr", "May", "May")
)

df <- data.frame(
  xdf = c(1,60,90, 30, 60, 90, 30, 60, 90, 45,95,45, 95),
 ydf = c(25, 22,20, 18, 28, 35,33, 29, 30, 38,31,26, 22),
 catdf = c("Jan","Jan", "Jan", "Feb","Feb", "Feb", "Mar",
  "Mar", "Mar", "Apr", "Apr", "May", "May")
)

#defining the rest of the arguments
list <- list(data, df)
vector_x <- c("xdata", "xdf")
vector_y <- c("ydata", "ydf")
vector_cat <-c("catdata", "catdf")
df_numbers <- c(1,2,2, 1)
point_cords <- c(1, 3, 4, 10)

#generating the svg string
plot<- line_chart_dense_custom(
  list,
  vector_x = c("xdata", "xdf"),
  vector_y = c("ydata", "ydf"),
  vector_cat = c("catdata", "catdf"),
  series_labels = c("Gamma inc.", "Delta inc."),
  df_numbers = df_numbers,
  point_cords = point_cords)

#showing the plot
plot

Generates line plot with markers on every value.

Description

Generates line plot with markers on every value.

Usage

line_chart_markers(
  data,
  x,
  series,
  series_labels,
  interval = "months",
  styles = NULL
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#preparing a data frame
data <- data.frame(
time = c("Jan", "Feb", "Mar", "Apr", "May", "Jun"),
PL = (c(51, 42, 50, 58, 78, 79) - 30),
AC = (c(62, 70, 67, 77, 63, 62) - 30)
)
#preparing the styles data frame
styles <- data.frame(
 PL = c("plan", "plan", "plan", "plan", "plan", "plan"),
 AC = c("actual", "actual", "actual", "forecast", "forecast", "forecast")
)

#generating svg string
line_chart <- line_chart_markers(data, data$time, c("PL", "AC"), c("PL", "AC"),"months", styles)

#show the plot
line_chart

Generates line plot with markers on every value with index on a given value.

Description

Generates line plot with markers on every value with index on a given value.

Usage

line_chart_markers_reference(
  data,
  x,
  series,
  series_labels,
  ref_val,
  ref_label = ref_val,
  interval = "months",
  styles = NULL
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#preparing a data frame
data <- data.frame(
time = c("Jan", "Feb", "Mar", "Apr", "May", "Jun"),
PL = (c(51, 42, 50, 58, 78, 79) - 30),
AC = (c(62, 70, 67, 77, 63, 62) - 30)
)
#preparing the styles data frame
styles <- data.frame(
 PL = c("plan", "plan", "plan", "plan", "plan", "plan"),
 AC = c("actual", "actual", "actual", "forecast", "forecast", "forecast")
)

#generating svg string
line_chart_ref <- line_chart_markers_reference(
  data = data,
  x = data$time,
  series = c("PL", "AC"),
  series_labels = c("PL", "AC"),
  ref_val = 42,
  ref_label = "index",
  styles=styles)

#show the plot
line_chart_ref

Generates normalized areas (stacked lines) plot. If more than one series is supplied, stacked areas plot is generated.

Description

Generates normalized areas (stacked lines) plot. If more than one series is supplied, stacked areas plot is generated.

Usage

line_chart_normalized(
  data,
  x,
  series,
  series_labels,
  show_labels,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#preparing data frames
data <- data.frame(
weeks =    c(28,   29, 30,  31,  32,  33,  34,  35,  36, 37),
Services = c(130,150, 182, 170, 170, 140, 130, 130, 135, 140),
Software = c(100, 88, 83,   90, 92,   95, 129, 130, 130, 135),
Products = c(20,  35, 36,    40, 22,  25, 24,   19,  36,  40)
)

#defining the rest of the arguments
series <- c("Software", "Services", "Products")
labels <- c(NA, 1, NA, 1, NA, NA, 1, NA, 1, NA)

#generating the SVG string
line_chart_normalized <- line_chart_normalized(data, data$weeks, series, series, labels, "weeks")

#show the plot
line_chart_normalized

Generates areas (stacked lines) plot. If more than one series is supplied, stacked areas plot is generated.

Description

Generates areas (stacked lines) plot. If more than one series is supplied, stacked areas plot is generated.

Usage

line_chart_stacked(
  data,
  cat,
  series,
  series_labels,
  show_labels,
  interval = "months"
)

Arguments

Value

object of class tidychart with a character vector containing SVG elements

Examples

#preparing data frames
data <- data.frame(
weeks =    c(28,   29, 30,  31,  32,  33,  34,  35,  36, 37),
Services = c(130,150, 182, 170, 170, 140, 130, 130, 135, 140),
Software = c(100, 88, 83,   90, 92,   95, 129, 130, 130, 135),
Products = c(20,  35, 36,    40, 22,  25, 24,   19,  36,  40)
)

#defining the rest of the arguments
series <- c("Software", "Services", "Products")
labels <- c(NA, 1, NA, 1, NA, NA, 1, NA, 1, NA)

#generating the SVG string
line_chart_stacked <- line_chart_stacked(data, data$weeks, series, series, labels, "weeks")

#show the plot
line_chart_stacked

Function to transfer data frame with time series values in wide format to format accepted by 'line_chart_dense_custom'.

Description

Function to transfer data frame with time series values in wide format to format accepted by 'line_chart_dense_custom'.

Usage

parse_time_series(df, dates, series, convert.to = "months")

Arguments

Value

list of data frames, each one containing data about one time series. Data frames in returned list consist of columns: * containing numeric values from 0 to 100 defining the percentage of distance in one time interval of the point (x - coordinates of the point) * containing the value of a point (y - coordinates of the point) * containing the time interval of the value

Examples

df <- data.frame(
    dates = as.Date(c('2021-07-12', '2021-06-18', '2021-05-12')),
    val1 = c(1.5, 1.2, 2.1),
    val2 = c(0.9, 3.2, 1.1))
parse_time_series(df, 'dates', c('val1', 'val2'))

Explicitly draw tidychart

Description

This function overrides default print method for tidycharts and prints them on the viewer pane in RStudio or as output in knitr.

Usage

## S3 method for class 'tidychart'
print(x, ...)

Arguments

Value

Invisibly returns the object of the tidychart class

Examples

# simply calling a plotting function will result in showing the chart
bar_chart(
  data = data.frame(
    cat = c('a', 'b', 'c'),
    series = c(12,15,16)),
  cat = 'cat',
  series = 'series')

# result of the plotting function can also be assigned
barchart <- bar_chart(
  data = data.frame(
    cat = c('a', 'b', 'c'),
    series = c(12,15,16)),
  cat = 'cat',
  series = 'series')
# and explicitly printed
print(barchart)
# or implicitly printed
barchart

Reset margin values to package defaults.

Description

Reset margin values to package defaults.

Usage

reset_margins()

Value

No return value, called for side effects.

Examples

reset_margins()

Restore default color and style settings.

Description

Restore default color and style settings.

Usage

restore_defaults()

Value

No return value, called for side effects.

Examples

restore_defaults()

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

Description

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

Usage

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

Value

object of class tidychart with a character vector containing SVG elements

Examples

# 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

Change default colors of the package.

Description

Customize your plots and change default color palette.

Usage

set_colors(colors_df)

Arguments

Value

No return value, called for side effects.

Examples

mi2lab_colors <- cbind(
  bar_colors =  c(
   "rgb(68, 19, 71)",
   "rgb(243, 46, 255)",
   "rgb(106, 0, 112)",
   "rgb(217, 43, 227)" ,
   "rgb(114, 49, 117)",
   "rgb(249, 110, 255)"
 ),
text_colors = c("white", "white", "white", "white", "white", "white"))

set_colors(mi2lab_colors)

Set margins size.

Description

Currently supported is setting 'top' and 'left' margins. Names of elements in x and keys in ... should be 'top' or 'left'.

Usage

set_margins(x = NULL, ...)

Arguments

Value

No return value, called for side effects.

Examples

set_margins(list(top = 75, left = 80))

set_margins(top = 75, left = 80)

Change default colors of the scatter plots from the package.

Description

Customize your scatter plots and change default color palette.

Usage

set_scatter_colors(new_scatter_colors)

Arguments

Value

No return value, called for side effects.

Examples

mi2lab_scatter_colors <- c(
   "rgb(68, 19, 71)",
   "rgb(243, 46, 255)",
   "rgb(106, 0, 112)",
   "rgb(217, 43, 227)" ,
   "rgb(114, 49, 117)",
   "rgb(249, 110, 255)"
 )

set_scatter_colors(mi2lab_scatter_colors)

Change default styles for plots.

Description

Change default styles for plots.

Usage

set_styles(styles_df)

Arguments

Value

No return value, called for side effects.

Examples

styles_df <-
  rbind(
  actual = c("rgb(64,64,64)", "rgb(64,64,64)"),
  previous =
    c("rgb(166,166,166)", "rgb(166,166,166)"),
  forecast =
    c("url(#diagonalHatch)", "rgb(64,64,64)"),
  plan = c("white", "rgb(64,64,64)"),
  total_white = c("white", "white")
  )
colnames(styles_df) <- c("fill", "stroke")

set_styles(styles_df)

Function to render SVG as bitmap, used only in tests

Description

Function to render SVG as bitmap, used only in tests

Usage

show(svg_string)

Arguments

Value

No return value, called for side effects

Examples

if(FALSE){

  df <- data.frame(x = c(1,2,3), y = c(4,5,6))

  column_chart(df, x = df$x, series = c("y")) %>% show()
}

Calculate string width in pixels

Description

Calculate string width in pixels

Usage

str_width(string, bold = FALSE)

Arguments

Value

string width in pixels