README.Rmd

---
output: github_document
---

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

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

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![Travis build status](https://travis-ci.org/xtreamsrl/tsviz.svg?branch=master)](https://travis-ci.org/donlelef/tsviz)
[![CRAN status](https://www.r-pkg.org/badges/version/tsviz)](https://CRAN.R-project.org/package=tsviz)
[![CRAN monthly downloads](https://cranlogs.r-pkg.org/badges/tsviz)](https://cran.r-project.org/package=tsviz)
[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/tsviz)](https://cran.r-project.org/package=tsviz)
[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/donlelef)
<!-- badges: end -->

<img src="man/figures/tsviz.png" align="right"/>

An RStudio addin to provide easy and interactive time series visualization.
To be visible to the addin, time series must be stored in a dataframe in the global environment, with:

- at least a column of type *Date*
- at least a column of type *numeric*

## Installation

You can install the released version of tsviz from [CRAN](https://CRAN.R-project.org) with:

```{r cran_install, eval=FALSE}
install.packages("tsviz")
```

Or install the development version from Github:

```{r github_install, eval=FALSE}
devtools::install_github("donlelef/tsviz")
```

Once you have installed the package, you do not need to load it with `library()`, the addins are installed on your machine as part of the package install process.

## Example

First, let us load some suitable data:

```{r example, message=FALSE}
library(tsviz)
prices <- crypto_prices
```

Then, we can run the addin:

![Tutorial gif](man/figures/tsviz.gif)

That's it.