Skip to content

Commit

Permalink
Formatting issue in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jkrijthe committed Nov 1, 2018
1 parent ebed20f commit dd33730
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ knitr::opts_chunk$set(

# R wrapper for Van der Maaten's Barnes-Hut implementation of t-Distributed Stochastic Neighbor Embedding

##Installation
## Installation

To install from CRAN:
```{r, eval = FALSE}
Expand All @@ -34,7 +34,7 @@ devtools::install_github("jkrijthe/Rtsne")
```


##Usage
## Usage
After installing the package, use the following code to run a simple example (to install, see below).
```{r example, fig.path="tools/"}
library(Rtsne) # Load package
Expand All @@ -45,10 +45,10 @@ plot(tsne_out$Y,col=iris_unique$Species,asp=1) # Plot the result
```


#Details
# Details
This R package offers a wrapper around the Barnes-Hut TSNE C++ implementation of [2] [3]. Changes were made to the original code to allow it to function as an R package and to add additional functionality and speed improvements.

#References
# References
[1] L.J.P. van der Maaten and G.E. Hinton. Visualizing High-Dimensional Data Using t-SNE. Journal of Machine Learning Research 9(Nov):2579-2605, 2008.

[2] L.J.P. van der Maaten. Barnes-Hut-SNE. In Proceedings of the International Conference on Learning Representations, 2013.
Expand Down
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ downloads](http://cranlogs.r-pkg.org/badges/Rtsne)](https://cran.r-project.org/p

# R wrapper for Van der Maaten’s Barnes-Hut implementation of t-Distributed Stochastic Neighbor Embedding

\#\#Installation
## Installation

To install from CRAN:

Expand All @@ -27,8 +27,10 @@ if(!require(devtools)) install.packages("devtools") # If not already installed
devtools::install_github("jkrijthe/Rtsne")
```

\#\#Usage After installing the package, use the following code to run a
simple example (to install, see below).
## Usage

After installing the package, use the following code to run a simple
example (to install, see below).

``` r
library(Rtsne) # Load package
Expand All @@ -40,12 +42,16 @@ plot(tsne_out$Y,col=iris_unique$Species,asp=1) # Plot the result

![](tools/example-1.png)<!-- -->

\#Details This R package offers a wrapper around the Barnes-Hut TSNE C++
# Details

This R package offers a wrapper around the Barnes-Hut TSNE C++
implementation of \[2\] \[3\]. Changes were made to the original code to
allow it to function as an R package and to add additional functionality
and speed improvements.

\#References \[1\] L.J.P. van der Maaten and G.E. Hinton. Visualizing
# References

\[1\] L.J.P. van der Maaten and G.E. Hinton. Visualizing
High-Dimensional Data Using t-SNE. Journal of Machine Learning Research
9(Nov):2579-2605, 2008.

Expand Down

0 comments on commit dd33730

Please sign in to comment.