README.Rmd

---
output: github_document
always_allow_html: yes
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# planetary

[![Project Status: WIP ? Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)
[![Build Status](https://travis-ci.org/jonmcalder/planetary.svg?branch=master)](https://travis-ci.org/jonmcalder/planetary)
[![codecov](https://codecov.io/gh/jonmcalder/planetary/branch/master/graph/badge.svg)](https://codecov.io/gh/jonmcalder/planetary)

planetary is an htmlwidget for the `planetary.js` library, which facilitates the creation of "awesome interactive globes for the web". Check out http://planetaryjs.com/ for more info.

![](img/ex-rotating.png)
![](img/ex-quake.png)

## Installation

You can install planetary from GitHub with:

```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("jonmcalder/planetary")
```

## Examples

Simple rotating planet example with random pings - also draggable and zoomable.

```{r example, eval=FALSE}
library(planetary)
planetary(rotate = 10)
```