From dd337301dc690664715bd1f13f8360076d552ba2 Mon Sep 17 00:00:00 2001 From: Jesse Krijthe Date: Thu, 1 Nov 2018 15:25:32 +0100 Subject: [PATCH] Formatting issue in README --- README.Rmd | 8 ++++---- README.md | 16 +++++++++++----- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/README.Rmd b/README.Rmd index 48b5a74..5a78a8e 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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} @@ -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 @@ -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. diff --git a/README.md b/README.md index e7f2a0e..10f8194 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 @@ -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.