README.md

In biggis-project/soh: Hotspot analysis and stability metrics

Summary

The R package soh ...

How to cite

To cite properly, call the R built-in command citation("soh") as follows:

library(soh)
citation("soh")

Basic example

library(soh)
set.seed(21)

r <- raster(matrix(rnorm(2500), 50))
w <- weight_matrix_circular_fade(11,2)
g <- GetisOrd(r, w)

plot_temp_map(r)
plot_weight_matrix(w)
plot_zscore(g, sigma_thresh = 1.9)

Download and Install

To download the development version of the package, type the following at the R command line:

install.packages("devtools")
devtools::install_github("biggis-project/soh", build_vignettes = TRUE)

How to contribute

• Fork, clone, edit, commit, push, create pull request
• Use RStudio
• Unit-testing: press CTRL+SHIFT+T in RStudio
• we know that is hard to write tests especially for a visual package like this

Reporting bugs and other issues

If you encounter a clear bug, please file a minimal reproducible example on github.

How to perform static code analysis and style checks

We use lintr which also performs the analysis on Travis-CI. Configuration for lintr is in .lintr file. Lints are treated as warnings, but we strive to be lint-free.

In RStudio, you can run lintr from the console as follows:

> lintr::lint_package()

Who do I talk to?

• Viliam Simko (main)
• Julian Bruns (backup)

biggis-project/soh documentation built on May 12, 2019, 8:30 p.m.