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%"
)
```

# tidycharts

<!-- badges: start -->
[![R-CMD-check](https://github.com/MI2DataLab/tidycharts/workflows/R-CMD-check/badge.svg)](https://github.com/MI2DataLab/tidycharts/actions)
[![CRAN monthly downloads](https://cranlogs.r-pkg.org/badges/tidycharts)](https://cran.r-project.org/package=tidycharts)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/tidycharts)](https://cran.r-project.org/package=tidycharts)
[![Codecov test coverage](https://codecov.io/gh/SawickiBartosz/tidycharts/branch/main/graph/badge.svg)](https://app.codecov.io/gh/SawickiBartosz/tidycharts?branch=main)
<!-- badges: end -->



The goal of tidycharts is to enable R users to create charts inspired by [International Business Communication Standards (IBCS)](https://www.ibcs.com/). The plots are generated in SVG format, so embedding them in HTML documents is straight forward. 

## Installation

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

``` {r setup, message=FALSE, warning = FALSE}
install.packages("tidycharts")
```

Development version from [GitHub](https://github.com/) can be installed with:

``` {r setup-github, message=FALSE, warning=FALSE, cache=TRUE}
devtools::install_github("MI2DataLab/tidycharts")
```

## Example

How to create IBCS inspired charts using tidycharts? 

```{r, eval=F}
library(tidycharts) # load the package

# create some data to visualize
df <- data.frame(months = month.abb[1:6],
                 values = round(5 + sin(1:6), 2))

# create chart in a form of character vector containing SVG content
column_chart(df, x = 'months', series = 'values')
```
```{r column-chart, echo=FALSE, out.width = '50%'}
knitr::include_graphics("man/figures/readme-column.png")
```

You can easily create other type of plots, ie. lineplots:

```{r eval=F} 
line_chart_markers(df, x = df$months, series = 'values', series_labels = 'values')
```

```{r line-chart, echo=FALSE, out.width = '50%'}
knitr::include_graphics("man/figures/readme-lines.png")
```