This repository has been archived by the owner on Jul 20, 2023. It is now read-only.
/
README.Rmd
109 lines (78 loc) · 3.83 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/"
)
```
## *This version of rEDM is no longer being maintained (as of October 2019) - please see https://github.com/SugiharaLab/rEDM/ for the latest version of the package*
# rEDM
[](https://travis-ci.org/ha0ye/rEDM)
[](https://doi.org/10.5281/zenodo.596502)
[](https://codecov.io/gh/ha0ye/rEDM)
[](https://cran.rstudio.com/web/packages/rEDM/index.html)
<img src="man/figures/rEDM.png" width="200px">
## Binder Demo
Try out the package without installation (after loading, try clicking on `README.Rmd` in the `Files` tab).
[](https://mybinder.org/v2/gh/ha0ye/rEDM/master?urlpath=rstudio)
## Overview
The `rEDM` package is a collection of methods for Empirical Dynamic Modeling (EDM). EDM is based on the mathematical theory of recontructing attractor manifolds from time series data, with applications to forecasting, causal inference, and more. It is based on research software previously developed for the Sugihara Lab (University of California San Diego, Scripps Institution of Oceanography).
## Installation
You can install rEDM from CRAN with:
```{r cran-installation, eval = FALSE}
install.packages("rEDM")
```
OR from github with:
```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("ha0ye/rEDM")
```
If you are on Windows, you may need to install [Rtools](https://cran.r-project.org/bin/windows/Rtools/) first, so that you have access to a C++ compiler.
## Example
```{r, include = FALSE}
knitr::opts_chunk$set(fig.width = 6, fig.height = 4)
par(mar = c(4, 4, 1, 1), mgp = c(2.5, 1, 0), oma = c(0, 0, 0, 0))
```
We begin by looking at annual time series of sunspots:
```{r sunspots}
dat <- data.frame(yr = as.numeric(time(sunspot.year)),
sunspot_count = as.numeric(sunspot.year))
plot(dat$yr, dat$sunspot_count, type = "l",
xlab = "year", ylab = "sunspots")
```
First, we use simplex to determine the optimal embedding dimension, E:
```{r determining E, warning = FALSE}
library(rEDM) # load the package
n <- NROW(dat)
lib <- c(1, floor(2/3 * n)) # indices for the first 2/3 of the time series
pred <- c(floor(2/3 * n) + 1, n) # indices for the final 1/3 of the time series
output <- simplex(dat, # input data (for data.frames, uses 2nd column)
lib = lib, pred = lib, # which portions of the data to train and predict
E = 1:10) # embedding dimensions to try
summary(output[, 1:9])
```
It looks like `E = 3` or `4` is optimal. Since we generally want a simpler model, if possible, let's go with `E = 3` to forecast the remaining 1/3 of the data.
```{r}
output <- simplex(dat,
lib = lib, pred = pred, # predict on last 1/3
E = 3,
stats_only = FALSE) # return predictions, too
predictions <- na.omit(output$model_output[[1]])
plot(dat$yr, dat$sunspot_count, type = "l",
xlab = "year", ylab = "sunspots")
lines(predictions$time, predictions$pred, col = "blue", lty = 2)
polygon(c(predictions$time, rev(predictions$time)),
c(predictions$pred - sqrt(predictions$pred_var),
rev(predictions$pred + sqrt(predictions$pred_var))),
col = rgb(0, 0, 1, 0.5), border = NA)
```
## Further Examples
Please see the package vignettes for more details:
```{r, eval = FALSE}
browseVignettes("rEDM")
```