Skip to content

Commit fa991ec

Browse files
authored
Merge pull request #8 from kadyb/main
update README
2 parents 5ed2052 + 94d6474 commit fa991ec

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

README.Rmd

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,21 @@ 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-
-->
2117

2218
<!-- badges: start -->
19+
[![CRAN version](https://www.r-pkg.org/badges/version/rgeomorphon)](https://CRAN.R-project.org/package=rgeomorphon)
20+
[![CRAN status](https://badges.cranchecks.info/worst/rgeomorphon.svg)](https://cran.r-project.org/web/checks/check_results_rgeomorphon.html)
2321
[![Development Version](https://brownag.r-universe.dev/badges/rgeomorphon)](https://brownag.r-universe.dev/)
2422
[![R-CMD-check Build Status](https://github.com/brownag/rgeomorphon/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/brownag/rgeomorphon/actions)
2523
[![rgeomorphon Manual](https://img.shields.io/badge/docs-HTML-informational)](https://humus.rocks/rgeomorphon/)
2624
<!-- badges: end -->
2725

2826
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.
27+
algorithm of [Jasiewicz and Stepinski (2013)](https://doi.org/10.1016/j.geomorph.2012.11.005)
28+
based largely on the GRASS GIS [r.geomorphon](https://grass.osgeo.org/grass-stable/manuals/r.geomorphon.html)
29+
module.
3130

32-
This implementation employs a novel algorithm written in C++ and 'RcppParallel'.
31+
This implementation employs a novel algorithm written in C++ and {RcppParallel}.
3332

3433
For the sake of simplicity, some GRASS-specific implementation details have not
3534
been added. See `?geomorphons` for details.

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@
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-
116
<!-- badges: start -->
127

8+
[![CRAN
9+
version](https://www.r-pkg.org/badges/version/rgeomorphon)](https://CRAN.R-project.org/package=rgeomorphon)
10+
[![CRAN
11+
status](https://badges.cranchecks.info/worst/rgeomorphon.svg)](https://cran.r-project.org/web/checks/check_results_rgeomorphon.html)
1312
[![Development
1413
Version](https://brownag.r-universe.dev/badges/rgeomorphon)](https://brownag.r-universe.dev/)
1514
[![R-CMD-check Build
@@ -19,12 +18,14 @@ Manual](https://img.shields.io/badge/docs-HTML-informational)](https://humus.roc
1918
<!-- badges: end -->
2019

2120
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.
21+
classification algorithm of [Jasiewicz and Stepinski
22+
(2013)](https://doi.org/10.1016/j.geomorph.2012.11.005) based largely on
23+
the GRASS GIS
24+
[r.geomorphon](https://grass.osgeo.org/grass-stable/manuals/r.geomorphon.html)
25+
module.
2526

2627
This implementation employs a novel algorithm written in C++ and
27-
RcppParallel.
28+
{RcppParallel}.
2829

2930
For the sake of simplicity, some GRASS-specific implementation details
3031
have not been added. See `?geomorphons` for details.
@@ -54,7 +55,7 @@ the Auckland volcanic field of New Zealand.
5455

5556
``` r
5657
library(terra)
57-
#> terra 1.8.56
58+
#> terra 1.8.86
5859
library(rgeomorphon)
5960

6061
# PARAMETERS
@@ -81,7 +82,7 @@ system.time({
8182
)
8283
})
8384
#> user system elapsed
84-
#> 0.060 0.005 0.052
85+
#> 0.066 0.004 0.057
8586

8687
# inspect result
8788
plot(c(dem, rg),
@@ -128,7 +129,7 @@ system.time({
128129
)
129130
})
130131
#> user system elapsed
131-
#> 0.102 0.000 0.082
132+
#> 0.105 0.001 0.088
132133

133134
# inspect result
134135
plot(c(dem, rg),
@@ -147,7 +148,7 @@ citation("rgeomorphon")
147148
#> To cite package 'rgeomorphon' in publications use:
148149
#>
149150
#> Brown A (2025). _rgeomorphon: A Lightweight Implementation of the
150-
#> Geomorphon Algorithm_. R package version 0.3.0,
151+
#> 'Geomorphon' Algorithm_. R package version 0.3.0,
151152
#> <https://github.com/brownag/rgeomorphon/>.
152153
#>
153154
#> Jasiewicz J, Stepinski T (2013). "Geomorphons - a pattern recognition

0 commit comments

Comments
 (0)