Skip to content

Commit 8bbb6f5

Browse files
committed
more readme edits
1 parent 308f09b commit 8bbb6f5

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# plotly
44

5-
An R package for creating interactive web-based graphs via [plotly](https://plot.ly/)'s JavaScript graphing library.
5+
An R package for creating interactive web graphics via [plotly.js](https://github.com/plotly/plotly.js).
66

77
## Installation
88

@@ -20,9 +20,9 @@ devtools::install_github("ropensci/plotly")
2020

2121
## Getting Started
2222

23-
### ggplot2 converter
23+
### Web-based ggplot2 graphics
2424

25-
If you use [ggplot2](http://cran.r-project.org/package=ggplot2), `ggplotly()` converts your plots to an interactive, web-based version! It also provides sensible tooltips, which can help us decode values encoded as visual properties in the plot.
25+
If you use [ggplot2](http://cran.r-project.org/package=ggplot2), `ggplotly()` converts your plots to an interactive, web-based version! It also provides sensible tooltips, which assists decoding of values encoded as visual properties in the plot.
2626

2727
```r
2828
library(plotly)
@@ -34,19 +34,19 @@ ggplotly(g)
3434

3535
![https://plot.ly/~cpsievert/9836](http://i.imgur.com/6G4zv7b.png)
3636

37-
If you'd like to see how `ggplotly()` does in converting different ggplot2 examples, we host a [plotly version](http://ropensci.github.io/plotly/) of the [official ggplot2 documentation](http://docs.ggplot2.org).
37+
If you'd like to see how `ggplotly()` does in converting different ggplot2 examples, we host a [plotly version](http://ropensci.github.io/plotly/) of the [official ggplot2 documentation](http://docs.ggplot2.org). We also have some of our own examples [here](https://plot.ly/ggplot2/).
3838

3939
### plotly's custom R interface
4040

41-
__plotly__ supports some chart types that ggplot2 doesn't (such as 3D [surface](https://plot.ly/r/3d-surface-plots/), [point](https://plot.ly/r/3d-scatter-plots/), and [line](https://plot.ly/r/3d-line-plots/) plots). You can create these (or any other plotly) charts using the high-level interface.
41+
__plotly__ supports some chart types that ggplot2 doesn't (such as 3D [surface](https://plot.ly/r/3d-surface-plots/), [point](https://plot.ly/r/3d-scatter-plots/), and [line](https://plot.ly/r/3d-line-plots/) plots). You can create these (or any other plotly) charts using `plot_ly()`.
4242

4343
```r
4444
plot_ly(z = volcano, type = "surface")
4545
```
4646

4747
![https://plot.ly/~brnvg/1134](https://plot.ly/~brnvg/1134.png)
4848

49-
For a more detailed overview of this interface, see [here](https://cran.r-project.org/web/packages/plotly/vignettes/intro.html)
49+
For a more concise overview of the `plot_ly()` interface, see [here](https://cran.r-project.org/web/packages/plotly/vignettes/intro.html). You might also find our [examples](https://plot.ly/r/#basic-charts) and the [figure reference](https://plot.ly/r/reference/) to be helpful.
5050

5151
### Hooking onto plotly events
5252

@@ -60,11 +60,6 @@ For a more detailed overview of this interface, see [here](https://cran.r-projec
6060

6161
You can also hook into these events without shiny using `htmlwidgets::onRender()` ([example](https://github.com/ropensci/plotly/tree/master/inst/examples/onRenderHover)). This, however, requires JavaScript knowledge and makes it much harder, if not impossible, to coordinate views between htmlwidgets.
6262

63-
## Documentation
64-
65-
* Examples and vignettes on plotly's R homepage - <https://plot.ly/r>
66-
* The complete figure reference guide - <https://plot.ly/r/reference>
67-
6863
## Contributing
6964

7065
Please read through our [contributing guidelines](https://github.com/ropensci/plotly/blob/master/CONTRIBUTING.md). Included are directions for opening issues, asking questions, contributing changes to plotly, and our code of conduct.

0 commit comments

Comments
 (0)