# rayshaderanimate

**Repository Path**: tidyfriday/rayshaderanimate

## Basic Information

- **Project Name**: rayshaderanimate
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-12-29
- **Last Updated**: 2020-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/zappingseb/rayshaderanimate.svg?branch=master)](https://travis-ci.org/zappingseb/rayshaderanimate)

# rayshaderanimate

A package to animate a GPX path on a 3d landscape - with [rayshader](http://rayshader.com)

## Purpose

This package shall be used to create a 3d flyover video of a GPX path. You can imagine
a cycling trip or a hike. You did it with a GPX tracker. This data shall now be plotted
onto a 3d landscape. This is what this package will do for you.

As an example the package contains one of [my](https://github.com/zappingseb) cycling
trips at the 21 hard hairpin bends of Alpe d'Huez. You can go through the vignette
of this package which explains [How to create the video?](https://zappingseb.github.io/rayshaderanimate/articles/create_video.html) or
read my [blog article](https://mail-wolf.de/?p=4439) about the package.

**Final videos**

*as a gif*

![](https://github.com/zappingseb/rayshaderanimate/raw/master/inst/video.gif)


*as a mp4*

[![](https://github.com/zappingseb/rayshaderanimate/raw/master/inst/youtube.png)](https://www.youtube.com/watch?v=iEqoR-HpKeU)

https://www.youtube.com/watch?v=iEqoR-HpKeU

## Functionality

Getting started:

```
devtools::install_github("zappingseb/rayshaderanimate")
```

### How to create a video?

Please go step by step through the vignette: [How to create the video?](https://zappingseb.github.io/rayshaderanimate/articles/create_video.html).

## API

### GPX read functions

Read in a gpx file to a table

```r
get_table_from_gpx()
```

Enrich the table with distance and speed measures. Convert it to a boundary box

```r
get_enriched_gpx_table()

get_bbox_from_gpx_table()s
```

### Elevation data functions

Elevation data can be downloaded from [SRTM](http://srtm.csi.cgiar.org/srtmdata/) or
be directly added by an [EUDEM](https://land.copernicus.eu/imagery-in-situ/eu-dem/eu-dem-v1.1?tab=downloada) file.

```r
el_mat <- get_elevdata_from_bbox()

el_mat_eudem <- get_elevdata_from_bbox(bbox = bbox,
  type ="EUDEM",
  file = "eu_dem_v11_E40N20/eu_dem_v11_E40N20.TIF")
  
get_elevdata_long(el_mat)
```

### Output plot functions

Two functions are provided for 2D outputs within this package:

```r
# Animate GPX line on 2d plot
plot_2d_animation()

# Plot a 2D raster of the bbox
plot_2d_elevdata()

```

### Creating a video

To create a video there is just the function [`video_animation()`](https://zappingseb.github.io/rayshaderanimate/reference/video_animation.html) which will do 
the most important job of this package. Rendering the video.

To create a video on shere shades there is the function [`video_animation_rayshade()`](https://zappingseb.github.io/rayshaderanimate/reference/video_animation_rayshade.html) which will render
an even nicer story video:

[![](https://github.com/zappingseb/rayshaderanimate/raw/master/inst/gpx_story.png)](https://www.youtube.com/watch?v=iEqoR-HpKeU)