Skip to content

correct argument description, typos, formatting... #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stragu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

correct argument description, typos, formatting... #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 23 additions & 21 deletions vignettes/wordcloud.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,65 +14,66 @@ vignette: >
---


This is an introduction to `wordcloud2` package. This package provides an HTML5 interface to wordcloud for data visualization. [Timdream's wordcloud2.js](https://github.com/timdream/wordcloud2.js) is used in this package.
This is an introduction to the `wordcloud2` package. This package provides an HTML5 interface to wordcloud for data visualization. [Timdream's wordcloud2.js](https://github.com/timdream/wordcloud2.js) is used in this package.
![png](img/wordcloud2.png)

This document show two main function in `Wordcloud2`:
This document describes two main functions in `wordcloud2`:

1. `wordcloud2`: provide traditional wordcloud with HTML5
2. `letterCloud`: provide wordcloud with selected word(letters).
1. `wordcloud2`: generate a traditional wordcloud with HTML5
2. `letterCloud`: generate a wordcloud shaped like one or several characters.

### install wordcloud2
### Install wordcloud2

You may have already installed this package. Well, I still want to leave this code here for installing.

You may have installed this package. Well, I still want to leave these codes here for installing.
```{r eval = F}
require(devtools)
install_github("lchiffon/wordcloud2")
```

### `wordlcoud2` function
### `wordcloud2` function

You can use wordcloud directly:
You can use wordcloud2 directly:
```{r}
library(wordcloud2)
wordcloud2(data = demoFreq)
```

`demoFreq` is a data.frame including word and freq in each column.
`demoFreq` is an example data.frame that includes `word` and `freq` columns.

```{r}
head(demoFreq)
```

### Parameters
- `data`
- A data frame including word and freq in each column
- A data.frame including `word` and `freq` columns
- `size`
- Font size, default is 1. The larger size means the bigger word.
- Font size, default is 1. The larger the size, the bigger the words.
- `fontFamily`
- Font to use.
- `fontWeight`
- Font weight to use, e.g. normal, bold or 600
- `color`
- color of the text, keyword 'random-dark' and 'random-light' can be used. color vector is also supported in this param
- Color of the text, keyword 'random-dark' and 'random-light' can be used. color vector is also supported in this param
- `minSize`
- A character string of the subtitle
- Minimum font size to draw on the canvas
- `backgroundColor`
- Color of the background.
- `gridSize`
- Size of the grid in pixels for marking the availability of the canvas the larger the grid size, the bigger the gap between words.
- `minRotation`
- If the word should rotate, the minimum rotation (in rad) the text should rotate.
- `maxRotation`
- If the word should rotate, the maximum rotation (in rad) the text should rotate. Set the two value equal to keep all text in one angle.
- If the word should rotate, the maximum rotation (in rad) the text should rotate. Set the two values equal to keep all text in one angle.
- `rotateRatio`
- Probability for the word to rotate. Set the number to 1 to always rotate.
- `shape`
- The shape of the "cloud" to draw. Can be a keyword present. Available presents are 'circle' (default), 'cardioid' (apple or heart shape curve, the most known polar equation), 'diamond' (alias of square), 'triangle-forward', 'triangle', 'pentagon', and 'star'.
- The shape of the "cloud" to draw. Can be a keyword present. Available keywords are 'circle' (default), 'cardioid' (apple or heart shape curve, the most known polar equation), 'diamond' (alias of square), 'triangle-forward', 'triangle', 'pentagon', and 'star'.
- `ellipticity`
- degree of "flatness" of the shape wordcloud2.js should draw.
- `figPath`
- A fig used for the wordcloud.
- A file to be used as a mask for the wordcloud (jpeg, jpg, png, bmp or gif)
- `widgetsize`
- size of the widgets

Expand All @@ -95,14 +96,14 @@ For example, `t.png` is A BIRD with black and white:
![png](img/t.png)

```{r eval = F}
figPath = system.file("examples/t.png",package = "wordcloud2")
wordcloud2(demoFreq, figPath = figPath, size = 1.5,color = "skyblue")
figPath = system.file("examples/t.png", package = "wordcloud2")
wordcloud2(demoFreq, figPath = figPath, size = 1.5, color = "skyblue")
```
![png](img/tcloud.png)

### `letterCloud` function

`letterCloud` provide the function to create a wordcloud with a word, like this:
`letterCloud` provides the function to create a wordcloud shapes like a word or a single character, like this:
```{r}
letterCloud(demoFreq, word = "R", size = 2)
```
Expand All @@ -113,12 +114,12 @@ Or:
letterCloud(demoFreq, word = "WORDCLOUD2", wordSize = 1)
```
![png](img/wordcloud2.png)
**wordcloud with fig and letterCloud may disappeared in Rstudio Viewer, open into brower when you meet this bug**
**Wordclouds generated with `figPath` or `letterCloud()` may disappear in the RStudio viewer. Use "show in new window" if you encounter this bug.**

#### Parameters

- `data`
- A data frame including word and freq in each column
- A data.frame including `word` and `freq` columns
- `word`
- A word to create shape for wordcloud.
- `wordSize`
Expand All @@ -127,6 +128,7 @@ letterCloud(demoFreq, word = "WORDCLOUD2", wordSize = 1)
- Letter font
- `...`
- Other parameters for wordcloud2

Go to [wordcloud2](http://github.com/lchiffon/wordcloud2) in the github to leave a comment or give this package a star.

### shiny
Expand Down