-
Notifications
You must be signed in to change notification settings - Fork 49
/
Copy pathREADME.Rmd
95 lines (72 loc) · 4.22 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
---
title: "streamgraph"
output:
html_document:
keep_md: true
md_document:
variant: markdown_github
---
streamgraph is an htmlwidget for making, well, _streamgraphs_.
[Sample Rmd](http://rpubs.com/hrbrmstr/59200)
A streamgraph (or "stream graph") is a type of stacked area graph
which is displaced around a central axis, resulting in a flowing,
organic shape. Streamgraphs were developed by Lee Byron and popularized
by their use in a February 2008 New York Times article on movie
box office revenues. ([Wikipedia](http://en.wikipedia.org/wiki/Streamgraph))
The x axis values can be continous or dates.
### TODO
- Support is planned for `xts` objects, but not for a bit.
- Support for categorical/discrete x axis
The following functions are implemented:
- `streamgraph` : Create a new streamgraph
- `sg_axis_x` : Modify streamgraph x axis formatting
- `sg_axis_y` : Modify streamgraph y axis formatting
- `sg_colors` : Modify streamgraph axis text, legend popup label text and tooltip text colors (NOTE: no longer modifies fill colors, use `sg_fill_*` for fill colors)
- `sg_legend` : Add select menu "legend" to interactive streamgraphs
- `sg_fill_brewer` : Specify a ColorBrewer palette to use for the stream fills
- `sg_fill_manual` : Specify a manual color palette to use for the stream fills
- `sg_fill_tableau` : Specify a Tableau color palette to use for the stream flls
- `sg_add_marker` : Annotate streamgraph with vertical line and label
- `sg_annotate` : Annotate streamgraph with a label
### News
- Version `0.8.1` released - ggplot2 movies fix; corrected numerous notes from CRAN check
- Version `0.8` released - support for negative Y axis numbers and upgrade to latest D3
- Version `0.7.5` released - `key`, `value` and `date` can be either bare or quoted
- Version `0.7` released - New `sg_add_marker` and `sg_annotation` to enable annotation of streamgraphs
- Version `0.6` released - New `scale` parameter to `streamgraph` lets you choose between continuous or date scales.
- Version `0.5.1` released - `sg_colors` now has nothing to do with the stream fills but _does_ set the axis text, legend popup label text and tooltip text.
- Version `0.5` released - deprecated use of `sg_colors`. Its functionality will change soon and is replaced by three `sg_fill_*` functions (`brewer`, `manual` and `tableau`) which makes more sense, is aligned to the `ggplot2` way of specifying fill aesthetics and now makes it easier to highly customize the streamgraph appearance.
- Versioin `0.4.2` released - fixed bug (thanks to teammate @bhaskarvk) that causes inconsistent color rendering for each area component (noticeable on resize of flexible width/height graphs)
- Version `0.4.1` released - removed warning message when supplying `POSIXct` values (remember, `POSIXct` still only works for granularities >= 1 day)
- Version `0.4` released - select menu "legend" (interactive only)
- Version `0.3.1` released - bug fix to fix error with `d3.stack`; `streamgraph` will now see if the date input is a year and automatically convert it to the necessary format (no need to use `as.Date`)
- Version `0.3` released - folks can have some fun with new `offset` and `interpolate` parameters to `streamgraph`
- Version `0.2.2` relased - rly rly rly fixed tooltips now, also assed ability to format y axis text
- Version `0.2.1` released - ok, working tool tips for realz now
- Version `0.2` released - working SVG tooltips; general code cleanup
- Version `0.1` released
### Installation
```{r eval=FALSE}
devtools::install_github("hrbrmstr/streamgraph")
```
```{r echo=FALSE, message=FALSE, warning=FALSE, error=FALSE}
options(width=120)
```
### Usage
```{r eval=FALSE}
library(streamgraph)
# current verison
packageVersion("streamgraph")
library(dplyr)
ggplot2movies::movies %>%
select(year, Action, Animation, Comedy, Drama, Documentary, Romance, Short) %>%
tidyr::gather(genre, value, -year) %>%
group_by(year, genre) %>%
tally(wt=value) -> dat
streamgraph(dat, "genre", "n", "year", interactive=TRUE) %>%
sg_axis_x(20, "year", "%Y") %>%
sg_fill_brewer("PuOr")
```
---------------
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.