-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.Rmd
72 lines (53 loc) · 2.8 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
---
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%"
)
```
# motif <img src="man/figures/logo.png" align="right" width="150" />
<!-- badges: start -->
[](https://cran.r-project.org/package=motif)
[](https://github.com/Nowosad/motif/actions)
[](https://app.codecov.io/gh/Nowosad/motif?branch=master)
[](https://cran.r-project.org/package=motif)
<!-- badges: end -->
The **motif** package implements and extends ideas of the pattern-based spatial analysis in R.
It describes spatial patterns of categorical raster data for any defined regular and irregular areas.
Patterns are represented quantitatively using built-in signatures based on co-occurrence matrices but also allows for any user-defined functions.
It enables spatial analysis such as search, change detection, and clustering to be performed on spatial patterns.
## Installation
You can install the released version of motif from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("motif")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("Nowosad/motif")
```
## Documentation
See the package's vignettes:
1. [Introduction to the motif package](https://jakubnowosad.com/motif/articles/v1_intro.html)
2. [Types of spatial patterns' signatures](https://jakubnowosad.com/motif/articles/v2_signatures.html)
3. [Spatial patterns' search](https://jakubnowosad.com/motif/articles/v3_search.html)
4. [Spatial patterns' comparision](https://jakubnowosad.com/motif/articles/v4_compare.html)
5. [Spatial patterns' clustering](https://jakubnowosad.com/motif/articles/v5_cluster.html)
6. [Extracting the proportion of different classes in many regular local landscapes](https://jakubnowosad.com/motif/articles/v6_composition.html)
## Contribution
Contributions to this package are welcome.
The preferred method of contribution is through a GitHub pull request.
Feel free to contact us by creating [an issue](https://github.com/Nowosad/motif/issues).
## Citation
To cite the `motif` package in publications, please use [this paper](https://doi.org/10.1007/s10980-020-01135-0):
Nowosad, J. Motif: an open-source R tool for pattern-based spatial analysis. Landscape Ecol (2021). https://doi.org/10.1007/s10980-020-01135-0
LaTeX/BibTeX version can be obtained with:
```
library(motif)
citation("motif")
```