commit	a371c672d5cfcf29f2ef258a49dcc0d21ddd8da8	[log] [tgz]
author	Marc Kupietz <kupietz@ids-mannheim.de>	Fri Dec 18 15:56:15 2020 +0100
committer	Marc Kupietz <kupietz@ids-mannheim.de>	Fri Dec 18 16:07:04 2020 +0100
tree	4af35dd98ed9647457654d815edc7bcda152bdba
parent	5214481fe4a316c333769cfec9f5efdd995aea12 [diff]

tree: 4af35dd98ed9647457654d815edc7bcda152bdba

Readme.md

Plot themes for the Leibniz Institute for the German Language (IDS)

Description

The package provides a collection themes for different plotting libraries, following the corporate design of the Leibniz Institute for the German Language (IDS) in Mannheim (Germany).

Installation

library(devtools)
install_git("https://korap.ids-mannheim.de/gerrit/IDS-Mannheim/idsThemeR")

Examples

highcharter – light

library(tidyverse)
library(highcharter)
library(idsThemeR)
highcharts_demo() %>%
   hc_add_theme(hc_theme_ids_light())

ggplot2 – dark with alternative colour palette

library(ggplot2)
library(idsThemeR)

dtemp <- data.frame(months = factor(rep(substr(month.name, 1, 3), 4),
                                    levels = substr(month.name, 1, 3)),
                    city = rep(c("Tokyo", "New York", "Berlin", "London"),
                               each = 12),
                    temp = c(7.0, 6.9, 9.5, 14.5, 18.2, 21.5,
                             25.2, 26.5, 23.3, 18.3, 13.9, 9.6,
                             -0.2, 0.8, 5.7, 11.3, 17.0, 22.0,
                             24.8, 24.1, 20.1, 14.1, 8.6, 2.5,
                             -0.9, 0.6, 3.5, 8.4, 13.5, 17.0,
                             18.6, 17.9, 14.3, 9.0, 3.9, 1.0,
                             3.9, 4.2, 5.7, 8.5, 11.9, 15.2,
                             17.0, 16.6, 14.2, 10.3, 6.6, 4.8))

ggplot(dtemp, aes(x = months, y = temp, group = city, color = city)) +
  geom_line() +
  geom_point(size = 1.1) +
  ggtitle("Monthly Average Temperature") +
  theme_ids(style="dark") +
  scale_colour_ids(palette="D3")

ggplot2 – light

dtemp <- data.frame(Months = factor(rep(substr(month.name, 1, 3), 4),
                                    levels = substr(month.name, 1, 3)),
                    City = rep(c("Tokyo", "New York", "Berlin", "London"),
                               each = 12),
                    Temperature = c(7.0, 6.9, 9.5, 14.5, 18.2, 21.5,
                             25.2, 26.5, 23.3, 18.3, 13.9, 9.6,
                             -0.2, 0.8, 5.7, 11.3, 17.0, 22.0,
                             24.8, 24.1, 20.1, 14.1, 8.6, 2.5,
                             -0.9, 0.6, 3.5, 8.4, 13.5, 17.0,
                             18.6, 17.9, 14.3, 9.0, 3.9, 1.0,
                             3.9, 4.2, 5.7, 8.5, 11.9, 15.2,
                             17.0, 16.6, 14.2, 10.3, 6.6, 4.8))

ggplot(dtemp, aes(x = Months, y = Temperature, group = City, color = City)) +
  geom_line() +
  geom_point(size = 1.1) +
  ggtitle("Monthly Average Temperature", subtitle="Source: WorldClimate.com") +
  theme_ids() +
  scale_colour_ids()

Default Palette

library(scales)
show_col(ids_pal()(20))

Adapted D3 based Palette

This palette should be used if the original palette colours can be misinterpreted as department colours.

library(scales)
show_col(ids_pal(palette="D3")(20))

Demos

More elaborate R scripts demonstrating the use of the package can be found in the demo folder.

Changes

See Changelog

Development and License

Authors: Marc Kupietz

This package is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for German Language (IDS).

It is published under the BSD-2 License.

Further Affected Licenses and Terms of Services

Highcharts

idsThemeR imports the highcharter package which has a dependency on Highcharts, a commercial JavaScript charting library. Highcharts offers both a commercial license as well as a free non-commercial license. Please review the licensing options and terms before using the highcharter plot options, as the idsThemeR license neither provides nor implies a license for Highcharts.

Highcharts is a Highsoft product which is not free for commercial and governmental use.

Contributions

Contributions are very welcome!

Your contributions should be committed via our Gerrit server to facilitate reviewing (see Gerrit Code Review - A Quick Introduction).

Please note that unless you explicitly state otherwise any contribution intentionally submitted for inclusion into this software shall – as this software itself – be under the BSD-2 License.