<commit_before># plotVR - Walk Through Your Data

This is a prototype to get your data into a Google Cardboard (VR) or into Augmented Reality (AR) and navigate using the computer keyboard.

> This package was presented at EuroPython 2019.
> Check out the recording video on <https://youtu.be/lxXC76jHc98?t=5h20m>. *The video covers the whole day in that room - the talk starts at 5h20m and ends at 5h46m.*

Are you bored by 3D-plots that only give you a simple rotatable 2d-projection? plotVR provides a simple way for data scientists to plot data, pick up a phone, get a real 3d impression - either by VR or by AR - and use the computer's keyboard to walk through the scatter plot (see [live demo](https://thomann.github.io/plotVR/plotVR/inst/)):

![Overview](images/overview.png?raw=true "Overview")

The technologies beneath this project are: a web server that handles the communication between the DataScience-session and the phone, WebSockets to quickly proxy the keyboard events, QR-codes facilitate the simple pairing of both, and an HTML-Page on the computer to grab the keyboard events. And the translation of these keyboard events into 3D terms is a nice exercise in three.js, OpenGL, and SceneKit for HTML, Android, and iOS resp.

> **Warning:** All data is transmitted unencrypted and everybody can connect! Please be carefule with private data!

> **Disclaimer:** This package is provided as-is and every usage is on your own ris.

## Installation

Install the R-package:
```r
devtools::install_github('thomann/plotVR',subdir='plotVR-R')
```
or the Python package:
```bash
pip install git+https://github.com/thomann/plotvr#egg=plotvr&subdirectory=plotvr-py
```
> The installation from sources currently needs symbolic links to work, which is a bit of an issue on windows (see below). If you cannot make it work, wait to obtain precompiled wheels.

Also check out the native mobile apps:
- iOS: <https://github.com/thomann/PlotAR-ios>
- Android: <https://github.com/thomann/plotVR-android>


## Quick Tour

Working with the package is meant to be seamless - but it is a little hard to explain in text. Please check out the above [video](https://youtu.be/lxXC76jHc98?t=5h27m) at 5h27m where the demo starts.

Here we will describe how to plot the data in RStudio or Jupyter, then view it on your device, and finally navigate through the scene.

### Plot your data

In R load and plot the first three dimensions of `iris` with `iris$Species` as color:<commit_msg>fixed problem with README.md description of pip install from git<commit_after># plotVR - Walk Through Your Data

This is a prototype to get your data into a Google Cardboard (VR) or into Augmented Reality (AR) and navigate using the computer keyboard.

> This package was presented at EuroPython 2019.
> Check out the recording video on <https://youtu.be/lxXC76jHc98?t=5h20m>. *The video covers the whole day in that room - the talk starts at 5h20m and ends at 5h46m.*

Are you bored by 3D-plots that only give you a simple rotatable 2d-projection? plotVR provides a simple way for data scientists to plot data, pick up a phone, get a real 3d impression - either by VR or by AR - and use the computer's keyboard to walk through the scatter plot (see [live demo](https://thomann.github.io/plotVR/plotVR/inst/)):

![Overview](images/overview.png?raw=true "Overview")

The technologies beneath this project are: a web server that handles the communication between the DataScience-session and the phone, WebSockets to quickly proxy the keyboard events, QR-codes facilitate the simple pairing of both, and an HTML-Page on the computer to grab the keyboard events. And the translation of these keyboard events into 3D terms is a nice exercise in three.js, OpenGL, and SceneKit for HTML, Android, and iOS resp.

> **Warning:** All data is transmitted unencrypted and everybody can connect! Please be carefule with private data!

> **Disclaimer:** This package is provided as-is and every usage is on your own ris.

## Installation

Install the R-package:
```r
devtools::install_github('thomann/plotVR',subdir='plotVR-R')
```
or the Python package:
```bash
pip install "git+https://github.com/thomann/plotVR#egg=plotvr&subdirectory=plotVR-py"
```
> The installation from sources currently needs symbolic links to work, which is a bit of an issue on windows (see below). If you cannot make it work, wait to obtain precompiled wheels.

Also check out the native mobile apps:
- iOS: <https://github.com/thomann/PlotAR-ios>
- Android: <https://github.com/thomann/plotVR-android>


## Quick Tour

Working with the package is meant to be seamless - but it is a little hard to explain in text. Please check out the above [video](https://youtu.be/lxXC76jHc98?t=5h27m) at 5h27m where the demo starts.

Here we will describe how to plot the data in RStudio or Jupyter, then view it on your device, and finally navigate through the scene.

### Plot your data

In R load and plot the first three dimensions of `iris` with `iris$Species` as color:
{'fraction_non_alphanumeric': 0.07701540308061612, 'fraction_numerical': 0.01240248049609922, 'mean_word_length': 4.537098560354374, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 19, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '437041', 'n_tokens_mistral': 1485, 'n_tokens_neox': 1382, 'n_words': 708}