README.Rmd

---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# SpatioTemporal.cluster

<!-- badges: start -->
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/kongdd/heatwave?branch=master&svg=true)](https://ci.appveyor.com/project/kongdd/heatwave)
[![Travis build status](https://travis-ci.org/kongdd/heatwave.svg?branch=master)](https://travis-ci.org/kongdd/heatwave)
[![Codecov test coverage](https://codecov.io/gh/kongdd/heatwave/branch/master/graph/badge.svg)](https://codecov.io/gh/kongdd/heatwave?branch=master)
<!-- badges: end -->

The goal of SMI is to ...

## Installation

### 安装Julia

- Install Julia (>=1.5.3)
- Install `StatsBase`, `RCall` package
- In Julia, `build RCall`, ensure `using RCall` works

### 安装SpatioTemporal.cluster
``` r
devtools::install_github("kongdd/SpatioTemporal.cluster")
```

## Example

推荐使用julia版本的`cluster_SpatioTemporal`，且设置`method = "tree"`，此版本下速度最快

``` r
library(SpatioTemporal.cluster)
clusterIds <- cluster_SpatioTemporal_julia(arr, method = "tree",
    ncell_connected = 1L, ncell_overlap = 5L, factor = 1e4, diag = FALSE) 
```

## References

- Samaniego et al. (2013), "Implications of Parameter Uncertainty on Soil Moisture Drought Analysis in Germany", J Hydrometeor, 2013 vol. 14 (1) pp. 47-68. http://journals.ametsoc.org/doi/abs/10.1175/JHM-D-12-075.1

- Samaniego et al. (2018), "Anthropogenic warming exacerbates European soil moisture droughts", Nature Climate change, 2018 pp. 1-9. http://dx.doi.org/10.1038/s41558-018-0138-5