View source: R/ccm-surrogate.R

Cross-mapping for a surrogate ensemble.

1 2 3 4 5 6 7 8 | ```
surrogate_ccm(original.data, E = 2, tau = 1,
library.size = ceiling(nrow(original.data) * 0.9), with.replacement = T,
RNGseed = 1111, exclusion.radius = E + 1, num.neighbours = E + 1,
epsilon = NULL, silent = T, lag = 0, lib = c(1,
nrow(original.data)[1]), pred = lib, random.libs = TRUE,
library.column = 1, target.column = 2, surrogate.column = target.column,
samples.surrogates = 100, n.surrogates = 100, parallel = F,
surrogate.method = "aaft")
``` |

`original.data` |
A data frame containing two columns - one for the presumed driver and one for the response. |

`E` |
The embedding dimension. Defaults to NULL, which triggers automated optimisation of the embedding dimension up to the dimension specified by 'max.E'. |

`tau` |
The embedding lag. Defaults to NULL, which triggers automated optimisation of the embedding lag up to the dimension specified by 'max.tau'. For sparsely sampled time series (for example geological time series), it is wise to set this value to 1. For densely sampled time series, this should be set to the first minima of the autocorrelation function of the presumed driver. |

`library.size` |
The size of each random library (training set). |

`with.replacement` |
Should samples be drawn with replacement? Defaults to TRUE. |

`RNGseed` |
A random number seed. For reproducibility. |

`exclusion.radius` |
The number of temporal neighbours to exclude for the leave-K-out cross validation. Defaults to E + 1. |

`num.neighbours` |
The number of nearest neighbours to use in predictions. Defaults to E + 1. |

`epsilon` |
Exlude neighbours if the are within a distance of 'epsilon' from the predictee. |

`silent` |
Suppress warnings? |

`lag` |
The lag (called prediction horizon in rEDM::ccm) for which to compute CCM. |

`lib` |
Indices of the original library time series to use as the library (training) set. |

`pred` |
Indices of the original target time series to use as prediction set. If this overlaps with the training set, make sure to use leave-K-out cross validation setting the 'exclusion.radius' parameters to a minimum of E + 1. |

`random.libs` |
Whether or not to sample random library (training) sets. Defaults to TRUE. |

`library.column` |
Integer indicating which column to use as the library column (presumed response). |

`target.column` |
Integer indicating which column to use as the target column (presumed driver). Defaults to the opposite of 'library.column'. |

`surrogate.column` |
Which column to use to generate surrogates. Defaults to the value of 'target.column' (the presumed driver). |

`samples.surrogates` |
The number of surrogate time series in the null ensemble. |

`n.surrogates` |
Should a surrogate test also be performed? If so, 'n.surrogates' sets the number of surrogate time series to use. By default, no surrogate test is performed (n.surrogates = 0). |

`parallel` |
Activate parallellisation? Defaults to true. Currently, this only works decently on Mac and Linux systems. |

`surrogate.method` |
Which method should be used to generate surrogate time series? Defaults to "AAFT". For more options, see the description of the 'surrogate_ensemble' function in this package. |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.