ROvis.plotly

Rijksoverheid Visualisatie - plotly

Description

A tool to uniformly visualise interactive graphs in 'plotly' using standardized Rijksoverheid (Dutch National Government) styling. This package is part of the [ROvis umbrella package] (https://github.com/rivm-syso/ROvis).

Installation

# Install from GitHub
# install.packages("pak")
# pak::pak("rivm-syso/ROvis.plotly")
install.packages("ROvis.plotly", repos = c('https://rivm-syso.r-universe.dev', 'https://cloud.r-project.org'))

Usage

A short example of on how to use the ro_ply_add_theme() function in combination with your plotly-object. For the full functionality, please see the vignettes.

bar_data <- tibble::tibble(
  Sex = c("Man", "Vrouw"),
  n = c(1234, 1675)
)

# Use the  color function for Rijksoverheid / RIVM colors
sex_colors <- c(
  "Man" = ro_color("hemelblauw"),
  "Vrouw" = ro_color("robijnrood")
)

# Create plotly bar chart
fig <- plot_ly(
  data = bar_data,
  x = ~Sex,
  y = ~n,
  type = "bar",
  color = ~Sex,
  colors = sex_colors,
  text = ~paste0(
    "Geslacht: <b>", Sex, "</b>",
    "<br>Aantal cases: <b>", 
    format(round(n, 0), big.mark = ".", decimal.mark = ",", scientific = FALSE), "</b>"
  ),
  hoverinfo = "text"
)

# Apply Rijksoverheid / RIVM theme
fig <- ro_ply_add_theme(fig, ro_ply_theme())

Support

First point of contact for questions: spin@rivm.nl (spin@rivm.nl)

Contributing

We welcome contributions! Before you start, please read CONTRIBUTING.md. It explains how to open an issue, our git etiquette (branches, commits, pull requests and reviews) and our code standards. See CONTRIBUTORS.md for the list of contributors.

Instructions for developers

For information about R package development, check the R Packages book. Below we describe the most important guidelines and practicalities.

Requirements

We use the testthat, lintr and roxygen2 package for development of tests, code style checks and automatic documentation. We also use the devtools and usethis package during development to adhere to standards for R packages and make developing easier! Install them in your Rstudio environment:

install.packages(testthat)
install.packages(lintr)
install.packages(roxygen2)
install.packages(quarto)
install.packages(pkgdown)
install.packages(devtools)
install.packages(usethis)

Guidelines

Type devtools::load_all() in your console each time you start developing. This loads all dependencies and non-exported functions in the NAMESPACE. This makes developing a lot easier!

To ensure code standardization and quality, follow these guidelines:

• Add tests with usethis::use_test()
• Add a new package dependency to the DESCRIPTION file with usethis::use_package(). We use the min_version argument to specify a minimum version.
• Add a new function dependency to the NAMESPACE with usethis::use_import_from()
• Add documentation to new functions by inserting a roxygen skeleton and use devtools::document() to create automatic documentation in the man folder

Authors and acknowledgment

This R package was created by ROvis team (spin@rivm.nl).

License

The code can be re-used under license EUPL v.1.2. See LICENCE for details.