README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

# 🚧 Work in progress – not ready for public use.

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# {tstools} -- a Time Series Toolbox for Official Statistics

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/tstools)](https://CRAN.R-project.org/package=tstools)
[![R-CMD-check](https://github.com/kof-ch/tstools/workflows/R-CMD-check/badge.svg)](https://github.com/kof-ch/tstools/actions)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/grand-total/tstools?color=blue)](https://r-pkg.org/pkg/tstools)
<!-- badges: end -->

Plot official statistics' time series conveniently: automatic legends, highlight windows, stacked bar chars with positive and negative contributions, sum-as-line option, two y-axes with automatic horizontal grids that fit both axes and other popular chart types. 'tstools' comes with a plethora of defaults to let you plot without setting an abundance of parameters first, but gives you the flexibility to tweak the defaults. In addition to charts, 'tstools' provides a super fast, 'data.table' backed time series I/O that allows the user to export / import long format, wide format and transposed wide format data to various file types. 

-> [pkgdown documentation](https://kof-ch.github.io/tstools/) <- 

## Installation

You can install the development version of tstools from [GitHub](https://github.com/) with:

``` r
# install.packages("remotes")
remotes::install_github("kof-ch/tstools")
```

## Example Use:  Time Series Charts with Legends by Default 

{tstools} lets you draw time series line charts that come with a legend out-of-the-box. Simply
feed the `tsplot()` function with a list of time series. 


```{r example, message=FALSE}
library(tstools)
## basic example code
tsl <- list(
  AirPassengers = AirPassengers,
  JohnsonJohnson = JohnsonJohnson
)

tsplot(tsl)
```

and use easily use 2 y-axis. (I know some argue those double axes are fundamentally flawed, but my peers didn't care and asked for it.)

```{r}
tsplot(
  "Air Passengers" = tsl$AirPassengers,
  tsr = list("Johnson & Johnson" = tsl$JohnsonJohnson)
)
```