Skip to content

Commit 6c59de6

Browse files
committed
Update README
1 parent 7e634a4 commit 6c59de6

File tree

2 files changed

+26
-15
lines changed

2 files changed

+26
-15
lines changed

README.Rmd

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,23 @@ knitr::opts_chunk$set(
1414
```
1515

1616
# rgeomorphon
17+
<!--
18+
[![CRAN version](https://www.r-pkg.org/badges/version/rgeomorphon)](https://CRAN.R-project.org/package=rgeomorphon)
19+
[![CRAN status](https://badges.cranchecks.info/worst/rgeomorphon.svg)](https://cran.r-project.org/web/checks/check_results_rgeomorphon.html)
20+
-->
1721

1822
<!-- badges: start -->
19-
[![R-CMD-check Build
20-
Status](https://github.com/brownag/rgeomorphon/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/brownag/rgeomorphon/actions)
21-
[![rgeomorphon
22-
Manual](https://img.shields.io/badge/docs-HTML-informational)](https://humus.rocks/rgeomorphon/)
23+
[![Development Version](https://brownag.r-universe.dev/badges/rgeomorphon)](https://brownag.r-universe.dev/)
24+
[![R-CMD-check Build Status](https://github.com/brownag/rgeomorphon/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/brownag/rgeomorphon/actions)
25+
[![rgeomorphon Manual](https://img.shields.io/badge/docs-HTML-informational)](https://humus.rocks/rgeomorphon/)
2326
<!-- badges: end -->
2427

25-
A lightweight implementation of the 'geomorphon' terrain
26-
form classification algorithm of Jasiewicz and Stepinski (2013) based
27-
largely on the 'GRASS GIS' 'r.geomorphon' module.
28-
29-
This implementation employs a novel algorithm written in C++ and 'RcppParallel'.
28+
A lightweight implementation of the geomorphon terrain form classification
29+
algorithm of Jasiewicz and Stepinski (2013) <doi:10.1016/j.geomorph.2012.11.005>
30+
based largely on the 'GRASS GIS' 'r.geomorphon' module.
3031

32+
This implementation employs a novel algorithm written in C++ and 'RcppParallel'.
33+
3134
For the sake of simplicity, some GRASS-specific implementation details have not
3235
been added. See `?geomorphons` for details.
3336

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,25 @@
33

44
# rgeomorphon
55

6+
<!--
7+
[![CRAN version](https://www.r-pkg.org/badges/version/rgeomorphon)](https://CRAN.R-project.org/package=rgeomorphon)
8+
[![CRAN status](https://badges.cranchecks.info/worst/rgeomorphon.svg)](https://cran.r-project.org/web/checks/check_results_rgeomorphon.html)
9+
-->
10+
611
<!-- badges: start -->
712

13+
[![Development
14+
Version](https://brownag.r-universe.dev/badges/rgeomorphon)](https://brownag.r-universe.dev/)
815
[![R-CMD-check Build
916
Status](https://github.com/brownag/rgeomorphon/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/brownag/rgeomorphon/actions)
1017
[![rgeomorphon
1118
Manual](https://img.shields.io/badge/docs-HTML-informational)](https://humus.rocks/rgeomorphon/)
1219
<!-- badges: end -->
1320

14-
A lightweight implementation of the ‘geomorphon’ terrain form
15-
classification algorithm of Jasiewicz and Stepinski (2013) based largely
16-
on the ‘GRASS GIS’ ‘r.geomorphon’ module.
21+
A lightweight implementation of the geomorphon terrain form
22+
classification algorithm of Jasiewicz and Stepinski (2013)
23+
<doi:10.1016/j.geomorph.2012.11.005> based largely on the ‘GRASS GIS’
24+
‘r.geomorphon’ module.
1725

1826
This implementation employs a novel algorithm written in C++ and
1927
‘RcppParallel’.
@@ -73,7 +81,7 @@ system.time({
7381
)
7482
})
7583
#> user system elapsed
76-
#> 0.078 0.003 0.069
84+
#> 0.058 0.005 0.050
7785

7886
# inspect result
7987
plot(c(dem, rg),
@@ -120,7 +128,7 @@ system.time({
120128
)
121129
})
122130
#> user system elapsed
123-
#> 0.130 0.006 0.116
131+
#> 0.097 0.002 0.079
124132

125133
# inspect result
126134
plot(c(dem, rg),
@@ -139,7 +147,7 @@ citation("rgeomorphon")
139147
#> To cite package 'rgeomorphon' in publications use:
140148
#>
141149
#> Brown A (2025). _rgeomorphon: A Lightweight Implementation of the
142-
#> 'Geomorphon' Algorithm_. R package version 0.1.0,
150+
#> 'Geomorphon' Algorithm_. R package version 0.3.0,
143151
#> <https://github.com/brownag/rgeomorphon/>.
144152
#>
145153
#> Jasiewicz J, Stepinski T (2013). "Geomorphons - a pattern recognition

0 commit comments

Comments
 (0)